Social Care Interoperability Platform FHIR Implementation Guide
Version: 0.1.0, Status: draft

Social Care Interoperability Platform FHIR Implementation Guide - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: MODS DSCR $transfer — Output Parameters

Official URL: https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/MODS-DSCRTransferParametersOutput-1 Version: 0.1.0
Draft as of 2026-03-24 Computable Name: MODSDSCRTransferParametersOutput

Output parameters for $transfer. Returns OperationOutcome first and echoes logical-only references (identifier + display).

Usages:

  • This Profile is not used by any profiles in this Implementation Guide

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Parameters 0..* Parameters Operation Request or Response
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for parameter ΣC 8..* BackboneElement Operation Parameter
Slice: Unordered, Open by value:name
Constraints: inv-1
.... parameter:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Name from the definition
.... parameter:operationOutcome ΣC 1..1 BackboneElement Operation Parameter
Constraints: inv-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Name from the definition
Fixed Value: operationOutcome
..... resource ΣC 1..1 OperationOutcome If parameter is a whole resource
.... parameter:subject ΣC 1..1 BackboneElement Operation Parameter
Constraints: inv-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Name from the definition
Fixed Value: subject
..... value[x] ΣC 1..1 Reference(MODS Patient) If parameter is a data type
...... identifier Σ 1..1 Identifier Logical reference, when literal reference is not known
....... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
....... system Σ 1..1 uri The namespace for the identifier value
Fixed Value: https://fhir.nhs.uk/Id/nhs-number
....... value Σ 1..1 string The value that is unique
Example General: 123456
...... display Σ 1..1 string Text alternative for the resource
.... parameter:fulfiller ΣC 1..1 BackboneElement Operation Parameter
Constraints: inv-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Name from the definition
Fixed Value: fulfiller
..... value[x] ΣC 1..1 Reference(MODS Organization) If parameter is a data type
...... identifier Σ 1..1 Identifier Logical reference, when literal reference is not known
....... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
....... system Σ 1..1 uri The namespace for the identifier value
Fixed Value: https://fhir.nhs.uk/Id/ods-organisation-code
....... value Σ 1..1 string The value that is unique
Example General: 123456
...... display Σ 1..1 string Text alternative for the resource
.... parameter:fulfilledBy ΣC 0..1 BackboneElement Operation Parameter
Constraints: inv-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Name from the definition
Fixed Value: fulfilledBy
..... value[x] ΣC 0..1 Reference(MODS Practitioner) If parameter is a data type
...... identifier Σ 1..1 Identifier Logical reference, when literal reference is not known
....... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
....... value Σ 1..1 string The value that is unique
Example General: 123456
...... display Σ 1..1 string Text alternative for the resource
.... parameter:requestor ΣC 1..1 BackboneElement Operation Parameter
Constraints: inv-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Name from the definition
Fixed Value: requestor
..... value[x] ΣC 1..1 Reference(MODS Organization) If parameter is a data type
...... identifier Σ 1..1 Identifier Logical reference, when literal reference is not known
....... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
....... system Σ 1..1 uri The namespace for the identifier value
Fixed Value: https://fhir.nhs.uk/Id/ods-organisation-code
....... value Σ 1..1 string The value that is unique
Example General: 123456
...... display Σ 1..1 string Text alternative for the resource
.... parameter:requestedBy ΣC 1..1 BackboneElement Operation Parameter
Constraints: inv-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Name from the definition
Fixed Value: requestedBy
..... value[x] ΣC 1..1 Reference(MODS Practitioner) If parameter is a data type
...... identifier Σ 1..1 Identifier Logical reference, when literal reference is not known
....... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
....... value Σ 1..1 string The value that is unique
Example General: 123456
...... display Σ 1..1 string Text alternative for the resource
.... parameter:targetCompletion ΣC 0..1 BackboneElement Operation Parameter
Constraints: inv-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Name from the definition
Fixed Value: targetCompletion
..... value[x] ΣC 1..1 date If parameter is a data type
.... parameter:status ΣC 1..1 BackboneElement Operation Parameter
Constraints: inv-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Name from the definition
Fixed Value: status
..... value[x] ΣC 1..1 code If parameter is a data type
Binding: MODS DSCR Transfer Status (required)
.... parameter:note ΣC 0..* BackboneElement Operation Parameter
Constraints: inv-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Name from the definition
Fixed Value: note
..... Slices for part Σ 2..* See parameter (Parameters) Named part of a multi-part parameter
Slice: Unordered, Open by value:name
...... part:All Slices Content/Rules for all slices
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... name Σ 1..1 string Name from the definition
...... part:date Σ 1..1 BackboneElement Named part of a multi-part parameter
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... name Σ 1..1 string Name from the definition
Fixed Value: date
....... value[x] ΣC 1..1 dateTime If parameter is a data type
...... part:text Σ 1..1 BackboneElement Named part of a multi-part parameter
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... name Σ 1..1 string Name from the definition
Fixed Value: text
....... value[x] ΣC 1..1 string If parameter is a data type
Max Length:250
.... parameter:statusLastUpdated ΣC 1..1 BackboneElement Operation Parameter
Constraints: inv-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Name from the definition
Fixed Value: statusLastUpdated
..... value[x] ΣC 1..1 dateTime If parameter is a data type
.... parameter:requestorTrackingId ΣC 1..1 BackboneElement Operation Parameter
Constraints: inv-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Name from the definition
Fixed Value: requestorTrackingId
..... value[x] ΣC 1..1 string If parameter is a data type
.... parameter:fulfillerTrackingId ΣC 0..1 BackboneElement Operation Parameter
Constraints: inv-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Name from the definition
Fixed Value: fulfillerTrackingId
..... value[x] ΣC 0..1 string If parameter is a data type

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Parameters.parameter:subject.​value[x].identifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Parameters.parameter:fulfiller.​value[x].identifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Parameters.parameter:fulfilledBy.​value[x].identifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Parameters.parameter:requestor.​value[x].identifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Parameters.parameter:requestedBy.​value[x].identifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Parameters.parameter:status.​value[x] Base required MODS DSCR Transfer Status 📦0.1.0 This IG

Constraints

Id Grade Path(s) Description Expression
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
inv-1 error Parameters.parameter, Parameters.parameter:operationOutcome, Parameters.parameter:subject, Parameters.parameter:fulfiller, Parameters.parameter:fulfilledBy, Parameters.parameter:requestor, Parameters.parameter:requestedBy, Parameters.parameter:targetCompletion, Parameters.parameter:status, Parameters.parameter:note, Parameters.parameter:statusLastUpdated, Parameters.parameter:requestorTrackingId, Parameters.parameter:fulfillerTrackingId A parameter must have one and only one of (value, resource, part) (part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists()))

This structure is derived from Parameters

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Parameters 0..* Parameters Operation Request or Response
... Slices for parameter 8..* BackboneElement Operation Parameter
Slice: Unordered, Open by value:name
.... parameter:operationOutcome 1..1 BackboneElement Operation Parameter
..... name 1..1 string Name from the definition
Fixed Value: operationOutcome
..... resource 1..1 OperationOutcome If parameter is a whole resource
.... parameter:subject 1..1 BackboneElement Operation Parameter
..... name 1..1 string Name from the definition
Fixed Value: subject
..... value[x] 1..1 Reference(MODS Patient) If parameter is a data type
...... reference 0..0 Literal reference, Relative, internal or absolute URL
...... identifier 1..1 Identifier Logical reference, when literal reference is not known
....... system 1..1 uri The namespace for the identifier value
Fixed Value: https://fhir.nhs.uk/Id/nhs-number
....... value 1..1 string The value that is unique
...... display 1..1 string Text alternative for the resource
.... parameter:fulfiller 1..1 BackboneElement Operation Parameter
..... name 1..1 string Name from the definition
Fixed Value: fulfiller
..... value[x] 1..1 Reference(MODS Organization) If parameter is a data type
...... reference 0..0 Literal reference, Relative, internal or absolute URL
...... identifier 1..1 Identifier Logical reference, when literal reference is not known
....... system 1..1 uri The namespace for the identifier value
Fixed Value: https://fhir.nhs.uk/Id/ods-organisation-code
....... value 1..1 string The value that is unique
...... display 1..1 string Text alternative for the resource
.... parameter:fulfilledBy 0..1 BackboneElement Operation Parameter
..... name 1..1 string Name from the definition
Fixed Value: fulfilledBy
..... value[x] 0..1 Reference(MODS Practitioner) If parameter is a data type
...... reference 0..0 Literal reference, Relative, internal or absolute URL
...... identifier 1..1 Identifier Logical reference, when literal reference is not known
....... value 1..1 string The value that is unique
...... display 1..1 string Text alternative for the resource
.... parameter:requestor 1..1 BackboneElement Operation Parameter
..... name 1..1 string Name from the definition
Fixed Value: requestor
..... value[x] 1..1 Reference(MODS Organization) If parameter is a data type
...... reference 0..0 Literal reference, Relative, internal or absolute URL
...... identifier 1..1 Identifier Logical reference, when literal reference is not known
....... system 1..1 uri The namespace for the identifier value
Fixed Value: https://fhir.nhs.uk/Id/ods-organisation-code
....... value 1..1 string The value that is unique
...... display 1..1 string Text alternative for the resource
.... parameter:requestedBy 1..1 BackboneElement Operation Parameter
..... name 1..1 string Name from the definition
Fixed Value: requestedBy
..... value[x] 1..1 Reference(MODS Practitioner) If parameter is a data type
...... reference 0..0 Literal reference, Relative, internal or absolute URL
...... identifier 1..1 Identifier Logical reference, when literal reference is not known
....... value 1..1 string The value that is unique
...... display 1..1 string Text alternative for the resource
.... parameter:targetCompletion 0..1 BackboneElement Operation Parameter
..... name 1..1 string Name from the definition
Fixed Value: targetCompletion
..... value[x] 1..1 date If parameter is a data type
.... parameter:status 1..1 BackboneElement Operation Parameter
..... name 1..1 string Name from the definition
Fixed Value: status
..... value[x] 1..1 code If parameter is a data type
Binding: MODS DSCR Transfer Status (required)
.... parameter:note 0..* BackboneElement Operation Parameter
..... name 1..1 string Name from the definition
Fixed Value: note
..... Slices for part 2..* Named part of a multi-part parameter
Slice: Unordered, Open by value:name
...... part:date 1..1 BackboneElement Named part of a multi-part parameter
....... name 1..1 string Name from the definition
Fixed Value: date
....... value[x] 1..1 dateTime If parameter is a data type
...... part:text 1..1 BackboneElement Named part of a multi-part parameter
....... name 1..1 string Name from the definition
Fixed Value: text
....... value[x] 1..1 string If parameter is a data type
Max Length:250
.... parameter:statusLastUpdated 1..1 BackboneElement Operation Parameter
..... name 1..1 string Name from the definition
Fixed Value: statusLastUpdated
..... value[x] 1..1 dateTime If parameter is a data type
.... parameter:requestorTrackingId 1..1 BackboneElement Operation Parameter
..... name 1..1 string Name from the definition
Fixed Value: requestorTrackingId
..... value[x] 1..1 string If parameter is a data type
.... parameter:fulfillerTrackingId 0..1 BackboneElement Operation Parameter
..... name 1..1 string Name from the definition
Fixed Value: fulfillerTrackingId
..... value[x] 0..1 string If parameter is a data type

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Parameters.parameter:status.​value[x] Base required MODS DSCR Transfer Status 📦0.1.0 This IG
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Parameters 0..* Parameters Operation Request or Response
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for parameter ΣC 8..* BackboneElement Operation Parameter
Slice: Unordered, Open by value:name
Constraints: inv-1
.... parameter:All Slices Content/Rules for all slices
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Name from the definition
..... value[x] ΣC 0..1 If parameter is a data type
...... valueBase64Binary base64Binary
...... valueBoolean boolean
...... valueCanonical canonical(Any)
...... valueCode code
...... valueDate date
...... valueDateTime dateTime
...... valueDecimal decimal
...... valueId id
...... valueInstant instant
...... valueInteger integer
...... valueMarkdown markdown
...... valueOid oid
...... valuePositiveInt positiveInt
...... valueString string
...... valueTime time
...... valueUnsignedInt unsignedInt
...... valueUri uri
...... valueUrl url
...... valueUuid uuid
...... valueAddress Address
...... valueAge Age
...... valueAnnotation Annotation
...... valueAttachment Attachment
...... valueCodeableConcept CodeableConcept
...... valueCoding Coding
...... valueContactPoint ContactPoint
...... valueCount Count
...... valueDistance Distance
...... valueDuration Duration
...... valueHumanName HumanName
...... valueIdentifier Identifier
...... valueMoney Money
...... valuePeriod Period
...... valueQuantity Quantity
...... valueRange Range
...... valueRatio Ratio
...... valueReference Reference(Any)
...... valueSampledData SampledData
...... valueSignature Signature
...... valueTiming Timing
...... valueContactDetail ContactDetail
...... valueContributor Contributor
...... valueDataRequirement DataRequirement
...... valueExpression Expression
...... valueParameterDefinition ParameterDefinition
...... valueRelatedArtifact RelatedArtifact
...... valueTriggerDefinition TriggerDefinition
...... valueUsageContext UsageContext
...... valueDosage Dosage
...... valueMeta Meta
..... resource ΣC 0..1 Resource If parameter is a whole resource
..... part Σ 0..* See parameter (Parameters) Named part of a multi-part parameter
.... parameter:operationOutcome ΣC 1..1 BackboneElement Operation Parameter
Constraints: inv-1
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Name from the definition
Fixed Value: operationOutcome
..... value[x] ΣC 0..1 If parameter is a data type
...... valueBase64Binary base64Binary
...... valueBoolean boolean
...... valueCanonical canonical(Any)
...... valueCode code
...... valueDate date
...... valueDateTime dateTime
...... valueDecimal decimal
...... valueId id
...... valueInstant instant
...... valueInteger integer
...... valueMarkdown markdown
...... valueOid oid
...... valuePositiveInt positiveInt
...... valueString string
...... valueTime time
...... valueUnsignedInt unsignedInt
...... valueUri uri
...... valueUrl url
...... valueUuid uuid
...... valueAddress Address
...... valueAge Age
...... valueAnnotation Annotation
...... valueAttachment Attachment
...... valueCodeableConcept CodeableConcept
...... valueCoding Coding
...... valueContactPoint ContactPoint
...... valueCount Count
...... valueDistance Distance
...... valueDuration Duration
...... valueHumanName HumanName
...... valueIdentifier Identifier
...... valueMoney Money
...... valuePeriod Period
...... valueQuantity Quantity
...... valueRange Range
...... valueRatio Ratio
...... valueReference Reference(Any)
...... valueSampledData SampledData
...... valueSignature Signature
...... valueTiming Timing
...... valueContactDetail ContactDetail
...... valueContributor Contributor
...... valueDataRequirement DataRequirement
...... valueExpression Expression
...... valueParameterDefinition ParameterDefinition
...... valueRelatedArtifact RelatedArtifact
...... valueTriggerDefinition TriggerDefinition
...... valueUsageContext UsageContext
...... valueDosage Dosage
...... valueMeta Meta
..... resource ΣC 1..1 OperationOutcome If parameter is a whole resource
..... part Σ 0..* See parameter (Parameters) Named part of a multi-part parameter
.... parameter:subject ΣC 1..1 BackboneElement Operation Parameter
Constraints: inv-1
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Name from the definition
Fixed Value: subject
..... value[x] ΣC 1..1 Reference(MODS Patient) If parameter is a data type
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
...... identifier Σ 1..1 Identifier Logical reference, when literal reference is not known
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
....... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
....... system Σ 1..1 uri The namespace for the identifier value
Fixed Value: https://fhir.nhs.uk/Id/nhs-number
....... value Σ 1..1 string The value that is unique
Example General: 123456
....... period Σ 0..1 Period Time period when id is/was valid for use
....... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
...... display Σ 1..1 string Text alternative for the resource
..... resource ΣC 0..1 Resource If parameter is a whole resource
..... part Σ 0..* See parameter (Parameters) Named part of a multi-part parameter
.... parameter:fulfiller ΣC 1..1 BackboneElement Operation Parameter
Constraints: inv-1
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Name from the definition
Fixed Value: fulfiller
..... value[x] ΣC 1..1 Reference(MODS Organization) If parameter is a data type
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
...... identifier Σ 1..1 Identifier Logical reference, when literal reference is not known
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
....... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
....... system Σ 1..1 uri The namespace for the identifier value
Fixed Value: https://fhir.nhs.uk/Id/ods-organisation-code
....... value Σ 1..1 string The value that is unique
Example General: 123456
....... period Σ 0..1 Period Time period when id is/was valid for use
....... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
...... display Σ 1..1 string Text alternative for the resource
..... resource ΣC 0..1 Resource If parameter is a whole resource
..... part Σ 0..* See parameter (Parameters) Named part of a multi-part parameter
.... parameter:fulfilledBy ΣC 0..1 BackboneElement Operation Parameter
Constraints: inv-1
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Name from the definition
Fixed Value: fulfilledBy
..... value[x] ΣC 0..1 Reference(MODS Practitioner) If parameter is a data type
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
...... identifier Σ 1..1 Identifier Logical reference, when literal reference is not known
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
....... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
....... system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
....... value Σ 1..1 string The value that is unique
Example General: 123456
....... period Σ 0..1 Period Time period when id is/was valid for use
....... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
...... display Σ 1..1 string Text alternative for the resource
..... resource ΣC 0..1 Resource If parameter is a whole resource
..... part Σ 0..* See parameter (Parameters) Named part of a multi-part parameter
.... parameter:requestor ΣC 1..1 BackboneElement Operation Parameter
Constraints: inv-1
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Name from the definition
Fixed Value: requestor
..... value[x] ΣC 1..1 Reference(MODS Organization) If parameter is a data type
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
...... identifier Σ 1..1 Identifier Logical reference, when literal reference is not known
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
....... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
....... system Σ 1..1 uri The namespace for the identifier value
Fixed Value: https://fhir.nhs.uk/Id/ods-organisation-code
....... value Σ 1..1 string The value that is unique
Example General: 123456
....... period Σ 0..1 Period Time period when id is/was valid for use
....... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
...... display Σ 1..1 string Text alternative for the resource
..... resource ΣC 0..1 Resource If parameter is a whole resource
..... part Σ 0..* See parameter (Parameters) Named part of a multi-part parameter
.... parameter:requestedBy ΣC 1..1 BackboneElement Operation Parameter
Constraints: inv-1
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Name from the definition
Fixed Value: requestedBy
..... value[x] ΣC 1..1 Reference(MODS Practitioner) If parameter is a data type
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
...... identifier Σ 1..1 Identifier Logical reference, when literal reference is not known
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
....... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
....... system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
....... value Σ 1..1 string The value that is unique
Example General: 123456
....... period Σ 0..1 Period Time period when id is/was valid for use
....... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
...... display Σ 1..1 string Text alternative for the resource
..... resource ΣC 0..1 Resource If parameter is a whole resource
..... part Σ 0..* See parameter (Parameters) Named part of a multi-part parameter
.... parameter:targetCompletion ΣC 0..1 BackboneElement Operation Parameter
Constraints: inv-1
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Name from the definition
Fixed Value: targetCompletion
..... value[x] ΣC 1..1 date If parameter is a data type
..... resource ΣC 0..1 Resource If parameter is a whole resource
..... part Σ 0..* See parameter (Parameters) Named part of a multi-part parameter
.... parameter:status ΣC 1..1 BackboneElement Operation Parameter
Constraints: inv-1
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Name from the definition
Fixed Value: status
..... value[x] ΣC 1..1 code If parameter is a data type
Binding: MODS DSCR Transfer Status (required)
..... resource ΣC 0..1 Resource If parameter is a whole resource
..... part Σ 0..* See parameter (Parameters) Named part of a multi-part parameter
.... parameter:note ΣC 0..* BackboneElement Operation Parameter
Constraints: inv-1
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Name from the definition
Fixed Value: note
..... value[x] ΣC 0..1 If parameter is a data type
...... valueBase64Binary base64Binary
...... valueBoolean boolean
...... valueCanonical canonical(Any)
...... valueCode code
...... valueDate date
...... valueDateTime dateTime
...... valueDecimal decimal
...... valueId id
...... valueInstant instant
...... valueInteger integer
...... valueMarkdown markdown
...... valueOid oid
...... valuePositiveInt positiveInt
...... valueString string
...... valueTime time
...... valueUnsignedInt unsignedInt
...... valueUri uri
...... valueUrl url
...... valueUuid uuid
...... valueAddress Address
...... valueAge Age
...... valueAnnotation Annotation
...... valueAttachment Attachment
...... valueCodeableConcept CodeableConcept
...... valueCoding Coding
...... valueContactPoint ContactPoint
...... valueCount Count
...... valueDistance Distance
...... valueDuration Duration
...... valueHumanName HumanName
...... valueIdentifier Identifier
...... valueMoney Money
...... valuePeriod Period
...... valueQuantity Quantity
...... valueRange Range
...... valueRatio Ratio
...... valueReference Reference(Any)
...... valueSampledData SampledData
...... valueSignature Signature
...... valueTiming Timing
...... valueContactDetail ContactDetail
...... valueContributor Contributor
...... valueDataRequirement DataRequirement
...... valueExpression Expression
...... valueParameterDefinition ParameterDefinition
...... valueRelatedArtifact RelatedArtifact
...... valueTriggerDefinition TriggerDefinition
...... valueUsageContext UsageContext
...... valueDosage Dosage
...... valueMeta Meta
..... resource ΣC 0..1 Resource If parameter is a whole resource
..... Slices for part Σ 2..* See parameter (Parameters) Named part of a multi-part parameter
Slice: Unordered, Open by value:name
...... part:All Slices Content/Rules for all slices
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... name Σ 1..1 string Name from the definition
....... value[x] ΣC 0..1 If parameter is a data type
........ valueBase64Binary base64Binary
........ valueBoolean boolean
........ valueCanonical canonical(Any)
........ valueCode code
........ valueDate date
........ valueDateTime dateTime
........ valueDecimal decimal
........ valueId id
........ valueInstant instant
........ valueInteger integer
........ valueMarkdown markdown
........ valueOid oid
........ valuePositiveInt positiveInt
........ valueString string
........ valueTime time
........ valueUnsignedInt unsignedInt
........ valueUri uri
........ valueUrl url
........ valueUuid uuid
........ valueAddress Address
........ valueAge Age
........ valueAnnotation Annotation
........ valueAttachment Attachment
........ valueCodeableConcept CodeableConcept
........ valueCoding Coding
........ valueContactPoint ContactPoint
........ valueCount Count
........ valueDistance Distance
........ valueDuration Duration
........ valueHumanName HumanName
........ valueIdentifier Identifier
........ valueMoney Money
........ valuePeriod Period
........ valueQuantity Quantity
........ valueRange Range
........ valueRatio Ratio
........ valueReference Reference(Any)
........ valueSampledData SampledData
........ valueSignature Signature
........ valueTiming Timing
........ valueContactDetail ContactDetail
........ valueContributor Contributor
........ valueDataRequirement DataRequirement
........ valueExpression Expression
........ valueParameterDefinition ParameterDefinition
........ valueRelatedArtifact RelatedArtifact
........ valueTriggerDefinition TriggerDefinition
........ valueUsageContext UsageContext
........ valueDosage Dosage
........ valueMeta Meta
....... resource ΣC 0..1 Resource If parameter is a whole resource
....... part Σ 0..* See parameter (Parameters) Named part of a multi-part parameter
...... part:date Σ 1..1 BackboneElement Named part of a multi-part parameter
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... name Σ 1..1 string Name from the definition
Fixed Value: date
....... value[x] ΣC 1..1 dateTime If parameter is a data type
....... resource ΣC 0..1 Resource If parameter is a whole resource
....... part Σ 0..* See parameter (Parameters) Named part of a multi-part parameter
...... part:text Σ 1..1 BackboneElement Named part of a multi-part parameter
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... name Σ 1..1 string Name from the definition
Fixed Value: text
....... value[x] ΣC 1..1 string If parameter is a data type
Max Length:250
....... resource ΣC 0..1 Resource If parameter is a whole resource
....... part Σ 0..* See parameter (Parameters) Named part of a multi-part parameter
.... parameter:statusLastUpdated ΣC 1..1 BackboneElement Operation Parameter
Constraints: inv-1
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Name from the definition
Fixed Value: statusLastUpdated
..... value[x] ΣC 1..1 dateTime If parameter is a data type
..... resource ΣC 0..1 Resource If parameter is a whole resource
..... part Σ 0..* See parameter (Parameters) Named part of a multi-part parameter
.... parameter:requestorTrackingId ΣC 1..1 BackboneElement Operation Parameter
Constraints: inv-1
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Name from the definition
Fixed Value: requestorTrackingId
..... value[x] ΣC 1..1 string If parameter is a data type
..... resource ΣC 0..1 Resource If parameter is a whole resource
..... part Σ 0..* See parameter (Parameters) Named part of a multi-part parameter
.... parameter:fulfillerTrackingId ΣC 0..1 BackboneElement Operation Parameter
Constraints: inv-1
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Name from the definition
Fixed Value: fulfillerTrackingId
..... value[x] ΣC 0..1 string If parameter is a data type
..... resource ΣC 0..1 Resource If parameter is a whole resource
..... part Σ 0..* See parameter (Parameters) Named part of a multi-part parameter

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Parameters.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Parameters.parameter:subject.​value[x].type Base extensible ResourceType 📍4.0.1 FHIR Std.
Parameters.parameter:subject.​value[x].identifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Parameters.parameter:subject.​value[x].identifier.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Parameters.parameter:fulfiller.​value[x].type Base extensible ResourceType 📍4.0.1 FHIR Std.
Parameters.parameter:fulfiller.​value[x].identifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Parameters.parameter:fulfiller.​value[x].identifier.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Parameters.parameter:fulfilledBy.​value[x].type Base extensible ResourceType 📍4.0.1 FHIR Std.
Parameters.parameter:fulfilledBy.​value[x].identifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Parameters.parameter:fulfilledBy.​value[x].identifier.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Parameters.parameter:requestor.​value[x].type Base extensible ResourceType 📍4.0.1 FHIR Std.
Parameters.parameter:requestor.​value[x].identifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Parameters.parameter:requestor.​value[x].identifier.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Parameters.parameter:requestedBy.​value[x].type Base extensible ResourceType 📍4.0.1 FHIR Std.
Parameters.parameter:requestedBy.​value[x].identifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Parameters.parameter:requestedBy.​value[x].identifier.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Parameters.parameter:status.​value[x] Base required MODS DSCR Transfer Status 📦0.1.0 This IG

Constraints

Id Grade Path(s) Description Expression
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
inv-1 error Parameters.parameter, Parameters.parameter:operationOutcome, Parameters.parameter:subject, Parameters.parameter:fulfiller, Parameters.parameter:fulfilledBy, Parameters.parameter:requestor, Parameters.parameter:requestedBy, Parameters.parameter:targetCompletion, Parameters.parameter:status, Parameters.parameter:note, Parameters.parameter:statusLastUpdated, Parameters.parameter:requestorTrackingId, Parameters.parameter:fulfillerTrackingId A parameter must have one and only one of (value, resource, part) (part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists()))

This structure is derived from Parameters

Summary

Mandatory: 31 elements(8 nested mandatory elements)
Fixed: 17 elements
Prohibited: 5 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Parameters.parameter
  • The element 1 is sliced based on the value of Parameters.parameter.part

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Parameters 0..* Parameters Operation Request or Response
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for parameter ΣC 8..* BackboneElement Operation Parameter
Slice: Unordered, Open by value:name
Constraints: inv-1
.... parameter:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Name from the definition
.... parameter:operationOutcome ΣC 1..1 BackboneElement Operation Parameter
Constraints: inv-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Name from the definition
Fixed Value: operationOutcome
..... resource ΣC 1..1 OperationOutcome If parameter is a whole resource
.... parameter:subject ΣC 1..1 BackboneElement Operation Parameter
Constraints: inv-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Name from the definition
Fixed Value: subject
..... value[x] ΣC 1..1 Reference(MODS Patient) If parameter is a data type
...... identifier Σ 1..1 Identifier Logical reference, when literal reference is not known
....... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
....... system Σ 1..1 uri The namespace for the identifier value
Fixed Value: https://fhir.nhs.uk/Id/nhs-number
....... value Σ 1..1 string The value that is unique
Example General: 123456
...... display Σ 1..1 string Text alternative for the resource
.... parameter:fulfiller ΣC 1..1 BackboneElement Operation Parameter
Constraints: inv-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Name from the definition
Fixed Value: fulfiller
..... value[x] ΣC 1..1 Reference(MODS Organization) If parameter is a data type
...... identifier Σ 1..1 Identifier Logical reference, when literal reference is not known
....... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
....... system Σ 1..1 uri The namespace for the identifier value
Fixed Value: https://fhir.nhs.uk/Id/ods-organisation-code
....... value Σ 1..1 string The value that is unique
Example General: 123456
...... display Σ 1..1 string Text alternative for the resource
.... parameter:fulfilledBy ΣC 0..1 BackboneElement Operation Parameter
Constraints: inv-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Name from the definition
Fixed Value: fulfilledBy
..... value[x] ΣC 0..1 Reference(MODS Practitioner) If parameter is a data type
...... identifier Σ 1..1 Identifier Logical reference, when literal reference is not known
....... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
....... value Σ 1..1 string The value that is unique
Example General: 123456
...... display Σ 1..1 string Text alternative for the resource
.... parameter:requestor ΣC 1..1 BackboneElement Operation Parameter
Constraints: inv-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Name from the definition
Fixed Value: requestor
..... value[x] ΣC 1..1 Reference(MODS Organization) If parameter is a data type
...... identifier Σ 1..1 Identifier Logical reference, when literal reference is not known
....... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
....... system Σ 1..1 uri The namespace for the identifier value
Fixed Value: https://fhir.nhs.uk/Id/ods-organisation-code
....... value Σ 1..1 string The value that is unique
Example General: 123456
...... display Σ 1..1 string Text alternative for the resource
.... parameter:requestedBy ΣC 1..1 BackboneElement Operation Parameter
Constraints: inv-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Name from the definition
Fixed Value: requestedBy
..... value[x] ΣC 1..1 Reference(MODS Practitioner) If parameter is a data type
...... identifier Σ 1..1 Identifier Logical reference, when literal reference is not known
....... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
....... value Σ 1..1 string The value that is unique
Example General: 123456
...... display Σ 1..1 string Text alternative for the resource
.... parameter:targetCompletion ΣC 0..1 BackboneElement Operation Parameter
Constraints: inv-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Name from the definition
Fixed Value: targetCompletion
..... value[x] ΣC 1..1 date If parameter is a data type
.... parameter:status ΣC 1..1 BackboneElement Operation Parameter
Constraints: inv-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Name from the definition
Fixed Value: status
..... value[x] ΣC 1..1 code If parameter is a data type
Binding: MODS DSCR Transfer Status (required)
.... parameter:note ΣC 0..* BackboneElement Operation Parameter
Constraints: inv-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Name from the definition
Fixed Value: note
..... Slices for part Σ 2..* See parameter (Parameters) Named part of a multi-part parameter
Slice: Unordered, Open by value:name
...... part:All Slices Content/Rules for all slices
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... name Σ 1..1 string Name from the definition
...... part:date Σ 1..1 BackboneElement Named part of a multi-part parameter
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... name Σ 1..1 string Name from the definition
Fixed Value: date
....... value[x] ΣC 1..1 dateTime If parameter is a data type
...... part:text Σ 1..1 BackboneElement Named part of a multi-part parameter
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... name Σ 1..1 string Name from the definition
Fixed Value: text
....... value[x] ΣC 1..1 string If parameter is a data type
Max Length:250
.... parameter:statusLastUpdated ΣC 1..1 BackboneElement Operation Parameter
Constraints: inv-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Name from the definition
Fixed Value: statusLastUpdated
..... value[x] ΣC 1..1 dateTime If parameter is a data type
.... parameter:requestorTrackingId ΣC 1..1 BackboneElement Operation Parameter
Constraints: inv-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Name from the definition
Fixed Value: requestorTrackingId
..... value[x] ΣC 1..1 string If parameter is a data type
.... parameter:fulfillerTrackingId ΣC 0..1 BackboneElement Operation Parameter
Constraints: inv-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Name from the definition
Fixed Value: fulfillerTrackingId
..... value[x] ΣC 0..1 string If parameter is a data type

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Parameters.parameter:subject.​value[x].identifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Parameters.parameter:fulfiller.​value[x].identifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Parameters.parameter:fulfilledBy.​value[x].identifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Parameters.parameter:requestor.​value[x].identifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Parameters.parameter:requestedBy.​value[x].identifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Parameters.parameter:status.​value[x] Base required MODS DSCR Transfer Status 📦0.1.0 This IG

Constraints

Id Grade Path(s) Description Expression
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
inv-1 error Parameters.parameter, Parameters.parameter:operationOutcome, Parameters.parameter:subject, Parameters.parameter:fulfiller, Parameters.parameter:fulfilledBy, Parameters.parameter:requestor, Parameters.parameter:requestedBy, Parameters.parameter:targetCompletion, Parameters.parameter:status, Parameters.parameter:note, Parameters.parameter:statusLastUpdated, Parameters.parameter:requestorTrackingId, Parameters.parameter:fulfillerTrackingId A parameter must have one and only one of (value, resource, part) (part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists()))

Differential View

This structure is derived from Parameters

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Parameters 0..* Parameters Operation Request or Response
... Slices for parameter 8..* BackboneElement Operation Parameter
Slice: Unordered, Open by value:name
.... parameter:operationOutcome 1..1 BackboneElement Operation Parameter
..... name 1..1 string Name from the definition
Fixed Value: operationOutcome
..... resource 1..1 OperationOutcome If parameter is a whole resource
.... parameter:subject 1..1 BackboneElement Operation Parameter
..... name 1..1 string Name from the definition
Fixed Value: subject
..... value[x] 1..1 Reference(MODS Patient) If parameter is a data type
...... reference 0..0 Literal reference, Relative, internal or absolute URL
...... identifier 1..1 Identifier Logical reference, when literal reference is not known
....... system 1..1 uri The namespace for the identifier value
Fixed Value: https://fhir.nhs.uk/Id/nhs-number
....... value 1..1 string The value that is unique
...... display 1..1 string Text alternative for the resource
.... parameter:fulfiller 1..1 BackboneElement Operation Parameter
..... name 1..1 string Name from the definition
Fixed Value: fulfiller
..... value[x] 1..1 Reference(MODS Organization) If parameter is a data type
...... reference 0..0 Literal reference, Relative, internal or absolute URL
...... identifier 1..1 Identifier Logical reference, when literal reference is not known
....... system 1..1 uri The namespace for the identifier value
Fixed Value: https://fhir.nhs.uk/Id/ods-organisation-code
....... value 1..1 string The value that is unique
...... display 1..1 string Text alternative for the resource
.... parameter:fulfilledBy 0..1 BackboneElement Operation Parameter
..... name 1..1 string Name from the definition
Fixed Value: fulfilledBy
..... value[x] 0..1 Reference(MODS Practitioner) If parameter is a data type
...... reference 0..0 Literal reference, Relative, internal or absolute URL
...... identifier 1..1 Identifier Logical reference, when literal reference is not known
....... value 1..1 string The value that is unique
...... display 1..1 string Text alternative for the resource
.... parameter:requestor 1..1 BackboneElement Operation Parameter
..... name 1..1 string Name from the definition
Fixed Value: requestor
..... value[x] 1..1 Reference(MODS Organization) If parameter is a data type
...... reference 0..0 Literal reference, Relative, internal or absolute URL
...... identifier 1..1 Identifier Logical reference, when literal reference is not known
....... system 1..1 uri The namespace for the identifier value
Fixed Value: https://fhir.nhs.uk/Id/ods-organisation-code
....... value 1..1 string The value that is unique
...... display 1..1 string Text alternative for the resource
.... parameter:requestedBy 1..1 BackboneElement Operation Parameter
..... name 1..1 string Name from the definition
Fixed Value: requestedBy
..... value[x] 1..1 Reference(MODS Practitioner) If parameter is a data type
...... reference 0..0 Literal reference, Relative, internal or absolute URL
...... identifier 1..1 Identifier Logical reference, when literal reference is not known
....... value 1..1 string The value that is unique
...... display 1..1 string Text alternative for the resource
.... parameter:targetCompletion 0..1 BackboneElement Operation Parameter
..... name 1..1 string Name from the definition
Fixed Value: targetCompletion
..... value[x] 1..1 date If parameter is a data type
.... parameter:status 1..1 BackboneElement Operation Parameter
..... name 1..1 string Name from the definition
Fixed Value: status
..... value[x] 1..1 code If parameter is a data type
Binding: MODS DSCR Transfer Status (required)
.... parameter:note 0..* BackboneElement Operation Parameter
..... name 1..1 string Name from the definition
Fixed Value: note
..... Slices for part 2..* Named part of a multi-part parameter
Slice: Unordered, Open by value:name
...... part:date 1..1 BackboneElement Named part of a multi-part parameter
....... name 1..1 string Name from the definition
Fixed Value: date
....... value[x] 1..1 dateTime If parameter is a data type
...... part:text 1..1 BackboneElement Named part of a multi-part parameter
....... name 1..1 string Name from the definition
Fixed Value: text
....... value[x] 1..1 string If parameter is a data type
Max Length:250
.... parameter:statusLastUpdated 1..1 BackboneElement Operation Parameter
..... name 1..1 string Name from the definition
Fixed Value: statusLastUpdated
..... value[x] 1..1 dateTime If parameter is a data type
.... parameter:requestorTrackingId 1..1 BackboneElement Operation Parameter
..... name 1..1 string Name from the definition
Fixed Value: requestorTrackingId
..... value[x] 1..1 string If parameter is a data type
.... parameter:fulfillerTrackingId 0..1 BackboneElement Operation Parameter
..... name 1..1 string Name from the definition
Fixed Value: fulfillerTrackingId
..... value[x] 0..1 string If parameter is a data type

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Parameters.parameter:status.​value[x] Base required MODS DSCR Transfer Status 📦0.1.0 This IG

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Parameters 0..* Parameters Operation Request or Response
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for parameter ΣC 8..* BackboneElement Operation Parameter
Slice: Unordered, Open by value:name
Constraints: inv-1
.... parameter:All Slices Content/Rules for all slices
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Name from the definition
..... value[x] ΣC 0..1 If parameter is a data type
...... valueBase64Binary base64Binary
...... valueBoolean boolean
...... valueCanonical canonical(Any)
...... valueCode code
...... valueDate date
...... valueDateTime dateTime
...... valueDecimal decimal
...... valueId id
...... valueInstant instant
...... valueInteger integer
...... valueMarkdown markdown
...... valueOid oid
...... valuePositiveInt positiveInt
...... valueString string
...... valueTime time
...... valueUnsignedInt unsignedInt
...... valueUri uri
...... valueUrl url
...... valueUuid uuid
...... valueAddress Address
...... valueAge Age
...... valueAnnotation Annotation
...... valueAttachment Attachment
...... valueCodeableConcept CodeableConcept
...... valueCoding Coding
...... valueContactPoint ContactPoint
...... valueCount Count
...... valueDistance Distance
...... valueDuration Duration
...... valueHumanName HumanName
...... valueIdentifier Identifier
...... valueMoney Money
...... valuePeriod Period
...... valueQuantity Quantity
...... valueRange Range
...... valueRatio Ratio
...... valueReference Reference(Any)
...... valueSampledData SampledData
...... valueSignature Signature
...... valueTiming Timing
...... valueContactDetail ContactDetail
...... valueContributor Contributor
...... valueDataRequirement DataRequirement
...... valueExpression Expression
...... valueParameterDefinition ParameterDefinition
...... valueRelatedArtifact RelatedArtifact
...... valueTriggerDefinition TriggerDefinition
...... valueUsageContext UsageContext
...... valueDosage Dosage
...... valueMeta Meta
..... resource ΣC 0..1 Resource If parameter is a whole resource
..... part Σ 0..* See parameter (Parameters) Named part of a multi-part parameter
.... parameter:operationOutcome ΣC 1..1 BackboneElement Operation Parameter
Constraints: inv-1
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Name from the definition
Fixed Value: operationOutcome
..... value[x] ΣC 0..1 If parameter is a data type
...... valueBase64Binary base64Binary
...... valueBoolean boolean
...... valueCanonical canonical(Any)
...... valueCode code
...... valueDate date
...... valueDateTime dateTime
...... valueDecimal decimal
...... valueId id
...... valueInstant instant
...... valueInteger integer
...... valueMarkdown markdown
...... valueOid oid
...... valuePositiveInt positiveInt
...... valueString string
...... valueTime time
...... valueUnsignedInt unsignedInt
...... valueUri uri
...... valueUrl url
...... valueUuid uuid
...... valueAddress Address
...... valueAge Age
...... valueAnnotation Annotation
...... valueAttachment Attachment
...... valueCodeableConcept CodeableConcept
...... valueCoding Coding
...... valueContactPoint ContactPoint
...... valueCount Count
...... valueDistance Distance
...... valueDuration Duration
...... valueHumanName HumanName
...... valueIdentifier Identifier
...... valueMoney Money
...... valuePeriod Period
...... valueQuantity Quantity
...... valueRange Range
...... valueRatio Ratio
...... valueReference Reference(Any)
...... valueSampledData SampledData
...... valueSignature Signature
...... valueTiming Timing
...... valueContactDetail ContactDetail
...... valueContributor Contributor
...... valueDataRequirement DataRequirement
...... valueExpression Expression
...... valueParameterDefinition ParameterDefinition
...... valueRelatedArtifact RelatedArtifact
...... valueTriggerDefinition TriggerDefinition
...... valueUsageContext UsageContext
...... valueDosage Dosage
...... valueMeta Meta
..... resource ΣC 1..1 OperationOutcome If parameter is a whole resource
..... part Σ 0..* See parameter (Parameters) Named part of a multi-part parameter
.... parameter:subject ΣC 1..1 BackboneElement Operation Parameter
Constraints: inv-1
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Name from the definition
Fixed Value: subject
..... value[x] ΣC 1..1 Reference(MODS Patient) If parameter is a data type
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
...... identifier Σ 1..1 Identifier Logical reference, when literal reference is not known
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
....... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
....... system Σ 1..1 uri The namespace for the identifier value
Fixed Value: https://fhir.nhs.uk/Id/nhs-number
....... value Σ 1..1 string The value that is unique
Example General: 123456
....... period Σ 0..1 Period Time period when id is/was valid for use
....... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
...... display Σ 1..1 string Text alternative for the resource
..... resource ΣC 0..1 Resource If parameter is a whole resource
..... part Σ 0..* See parameter (Parameters) Named part of a multi-part parameter
.... parameter:fulfiller ΣC 1..1 BackboneElement Operation Parameter
Constraints: inv-1
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Name from the definition
Fixed Value: fulfiller
..... value[x] ΣC 1..1 Reference(MODS Organization) If parameter is a data type
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
...... identifier Σ 1..1 Identifier Logical reference, when literal reference is not known
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
....... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
....... system Σ 1..1 uri The namespace for the identifier value
Fixed Value: https://fhir.nhs.uk/Id/ods-organisation-code
....... value Σ 1..1 string The value that is unique
Example General: 123456
....... period Σ 0..1 Period Time period when id is/was valid for use
....... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
...... display Σ 1..1 string Text alternative for the resource
..... resource ΣC 0..1 Resource If parameter is a whole resource
..... part Σ 0..* See parameter (Parameters) Named part of a multi-part parameter
.... parameter:fulfilledBy ΣC 0..1 BackboneElement Operation Parameter
Constraints: inv-1
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Name from the definition
Fixed Value: fulfilledBy
..... value[x] ΣC 0..1 Reference(MODS Practitioner) If parameter is a data type
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
...... identifier Σ 1..1 Identifier Logical reference, when literal reference is not known
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
....... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
....... system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
....... value Σ 1..1 string The value that is unique
Example General: 123456
....... period Σ 0..1 Period Time period when id is/was valid for use
....... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
...... display Σ 1..1 string Text alternative for the resource
..... resource ΣC 0..1 Resource If parameter is a whole resource
..... part Σ 0..* See parameter (Parameters) Named part of a multi-part parameter
.... parameter:requestor ΣC 1..1 BackboneElement Operation Parameter
Constraints: inv-1
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Name from the definition
Fixed Value: requestor
..... value[x] ΣC 1..1 Reference(MODS Organization) If parameter is a data type
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
...... identifier Σ 1..1 Identifier Logical reference, when literal reference is not known
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
....... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
....... system Σ 1..1 uri The namespace for the identifier value
Fixed Value: https://fhir.nhs.uk/Id/ods-organisation-code
....... value Σ 1..1 string The value that is unique
Example General: 123456
....... period Σ 0..1 Period Time period when id is/was valid for use
....... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
...... display Σ 1..1 string Text alternative for the resource
..... resource ΣC 0..1 Resource If parameter is a whole resource
..... part Σ 0..* See parameter (Parameters) Named part of a multi-part parameter
.... parameter:requestedBy ΣC 1..1 BackboneElement Operation Parameter
Constraints: inv-1
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Name from the definition
Fixed Value: requestedBy
..... value[x] ΣC 1..1 Reference(MODS Practitioner) If parameter is a data type
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
...... identifier Σ 1..1 Identifier Logical reference, when literal reference is not known
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
....... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
....... system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
....... value Σ 1..1 string The value that is unique
Example General: 123456
....... period Σ 0..1 Period Time period when id is/was valid for use
....... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
...... display Σ 1..1 string Text alternative for the resource
..... resource ΣC 0..1 Resource If parameter is a whole resource
..... part Σ 0..* See parameter (Parameters) Named part of a multi-part parameter
.... parameter:targetCompletion ΣC 0..1 BackboneElement Operation Parameter
Constraints: inv-1
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Name from the definition
Fixed Value: targetCompletion
..... value[x] ΣC 1..1 date If parameter is a data type
..... resource ΣC 0..1 Resource If parameter is a whole resource
..... part Σ 0..* See parameter (Parameters) Named part of a multi-part parameter
.... parameter:status ΣC 1..1 BackboneElement Operation Parameter
Constraints: inv-1
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Name from the definition
Fixed Value: status
..... value[x] ΣC 1..1 code If parameter is a data type
Binding: MODS DSCR Transfer Status (required)
..... resource ΣC 0..1 Resource If parameter is a whole resource
..... part Σ 0..* See parameter (Parameters) Named part of a multi-part parameter
.... parameter:note ΣC 0..* BackboneElement Operation Parameter
Constraints: inv-1
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Name from the definition
Fixed Value: note
..... value[x] ΣC 0..1 If parameter is a data type
...... valueBase64Binary base64Binary
...... valueBoolean boolean
...... valueCanonical canonical(Any)
...... valueCode code
...... valueDate date
...... valueDateTime dateTime
...... valueDecimal decimal
...... valueId id
...... valueInstant instant
...... valueInteger integer
...... valueMarkdown markdown
...... valueOid oid
...... valuePositiveInt positiveInt
...... valueString string
...... valueTime time
...... valueUnsignedInt unsignedInt
...... valueUri uri
...... valueUrl url
...... valueUuid uuid
...... valueAddress Address
...... valueAge Age
...... valueAnnotation Annotation
...... valueAttachment Attachment
...... valueCodeableConcept CodeableConcept
...... valueCoding Coding
...... valueContactPoint ContactPoint
...... valueCount Count
...... valueDistance Distance
...... valueDuration Duration
...... valueHumanName HumanName
...... valueIdentifier Identifier
...... valueMoney Money
...... valuePeriod Period
...... valueQuantity Quantity
...... valueRange Range
...... valueRatio Ratio
...... valueReference Reference(Any)
...... valueSampledData SampledData
...... valueSignature Signature
...... valueTiming Timing
...... valueContactDetail ContactDetail
...... valueContributor Contributor
...... valueDataRequirement DataRequirement
...... valueExpression Expression
...... valueParameterDefinition ParameterDefinition
...... valueRelatedArtifact RelatedArtifact
...... valueTriggerDefinition TriggerDefinition
...... valueUsageContext UsageContext
...... valueDosage Dosage
...... valueMeta Meta
..... resource ΣC 0..1 Resource If parameter is a whole resource
..... Slices for part Σ 2..* See parameter (Parameters) Named part of a multi-part parameter
Slice: Unordered, Open by value:name
...... part:All Slices Content/Rules for all slices
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... name Σ 1..1 string Name from the definition
....... value[x] ΣC 0..1 If parameter is a data type
........ valueBase64Binary base64Binary
........ valueBoolean boolean
........ valueCanonical canonical(Any)
........ valueCode code
........ valueDate date
........ valueDateTime dateTime
........ valueDecimal decimal
........ valueId id
........ valueInstant instant
........ valueInteger integer
........ valueMarkdown markdown
........ valueOid oid
........ valuePositiveInt positiveInt
........ valueString string
........ valueTime time
........ valueUnsignedInt unsignedInt
........ valueUri uri
........ valueUrl url
........ valueUuid uuid
........ valueAddress Address
........ valueAge Age
........ valueAnnotation Annotation
........ valueAttachment Attachment
........ valueCodeableConcept CodeableConcept
........ valueCoding Coding
........ valueContactPoint ContactPoint
........ valueCount Count
........ valueDistance Distance
........ valueDuration Duration
........ valueHumanName HumanName
........ valueIdentifier Identifier
........ valueMoney Money
........ valuePeriod Period
........ valueQuantity Quantity
........ valueRange Range
........ valueRatio Ratio
........ valueReference Reference(Any)
........ valueSampledData SampledData
........ valueSignature Signature
........ valueTiming Timing
........ valueContactDetail ContactDetail
........ valueContributor Contributor
........ valueDataRequirement DataRequirement
........ valueExpression Expression
........ valueParameterDefinition ParameterDefinition
........ valueRelatedArtifact RelatedArtifact
........ valueTriggerDefinition TriggerDefinition
........ valueUsageContext UsageContext
........ valueDosage Dosage
........ valueMeta Meta
....... resource ΣC 0..1 Resource If parameter is a whole resource
....... part Σ 0..* See parameter (Parameters) Named part of a multi-part parameter
...... part:date Σ 1..1 BackboneElement Named part of a multi-part parameter
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... name Σ 1..1 string Name from the definition
Fixed Value: date
....... value[x] ΣC 1..1 dateTime If parameter is a data type
....... resource ΣC 0..1 Resource If parameter is a whole resource
....... part Σ 0..* See parameter (Parameters) Named part of a multi-part parameter
...... part:text Σ 1..1 BackboneElement Named part of a multi-part parameter
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... name Σ 1..1 string Name from the definition
Fixed Value: text
....... value[x] ΣC 1..1 string If parameter is a data type
Max Length:250
....... resource ΣC 0..1 Resource If parameter is a whole resource
....... part Σ 0..* See parameter (Parameters) Named part of a multi-part parameter
.... parameter:statusLastUpdated ΣC 1..1 BackboneElement Operation Parameter
Constraints: inv-1
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Name from the definition
Fixed Value: statusLastUpdated
..... value[x] ΣC 1..1 dateTime If parameter is a data type
..... resource ΣC 0..1 Resource If parameter is a whole resource
..... part Σ 0..* See parameter (Parameters) Named part of a multi-part parameter
.... parameter:requestorTrackingId ΣC 1..1 BackboneElement Operation Parameter
Constraints: inv-1
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Name from the definition
Fixed Value: requestorTrackingId
..... value[x] ΣC 1..1 string If parameter is a data type
..... resource ΣC 0..1 Resource If parameter is a whole resource
..... part Σ 0..* See parameter (Parameters) Named part of a multi-part parameter
.... parameter:fulfillerTrackingId ΣC 0..1 BackboneElement Operation Parameter
Constraints: inv-1
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name Σ 1..1 string Name from the definition
Fixed Value: fulfillerTrackingId
..... value[x] ΣC 0..1 string If parameter is a data type
..... resource ΣC 0..1 Resource If parameter is a whole resource
..... part Σ 0..* See parameter (Parameters) Named part of a multi-part parameter

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Parameters.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Parameters.parameter:subject.​value[x].type Base extensible ResourceType 📍4.0.1 FHIR Std.
Parameters.parameter:subject.​value[x].identifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Parameters.parameter:subject.​value[x].identifier.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Parameters.parameter:fulfiller.​value[x].type Base extensible ResourceType 📍4.0.1 FHIR Std.
Parameters.parameter:fulfiller.​value[x].identifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Parameters.parameter:fulfiller.​value[x].identifier.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Parameters.parameter:fulfilledBy.​value[x].type Base extensible ResourceType 📍4.0.1 FHIR Std.
Parameters.parameter:fulfilledBy.​value[x].identifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Parameters.parameter:fulfilledBy.​value[x].identifier.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Parameters.parameter:requestor.​value[x].type Base extensible ResourceType 📍4.0.1 FHIR Std.
Parameters.parameter:requestor.​value[x].identifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Parameters.parameter:requestor.​value[x].identifier.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Parameters.parameter:requestedBy.​value[x].type Base extensible ResourceType 📍4.0.1 FHIR Std.
Parameters.parameter:requestedBy.​value[x].identifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Parameters.parameter:requestedBy.​value[x].identifier.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
Parameters.parameter:status.​value[x] Base required MODS DSCR Transfer Status 📦0.1.0 This IG

Constraints

Id Grade Path(s) Description Expression
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
inv-1 error Parameters.parameter, Parameters.parameter:operationOutcome, Parameters.parameter:subject, Parameters.parameter:fulfiller, Parameters.parameter:fulfilledBy, Parameters.parameter:requestor, Parameters.parameter:requestedBy, Parameters.parameter:targetCompletion, Parameters.parameter:status, Parameters.parameter:note, Parameters.parameter:statusLastUpdated, Parameters.parameter:requestorTrackingId, Parameters.parameter:fulfillerTrackingId A parameter must have one and only one of (value, resource, part) (part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists()))

This structure is derived from Parameters

Summary

Mandatory: 31 elements(8 nested mandatory elements)
Fixed: 17 elements
Prohibited: 5 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Parameters.parameter
  • The element 1 is sliced based on the value of Parameters.parameter.part

 

Other representations of profile: CSV, Excel, Schematron