BC Client Registry FHIR Implementation Guide
1.0.0 - Build CI
BC Client Registry FHIR Implementation Guide - Local Development build (v1.0.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
Official URL: http://hlth.gov.bc.ca/fhir/client/StructureDefinition/bc-metadata-parameters-out | Version: 1.0.0 | |||
Active as of 2024-06-07 | Computable Name: MetadataParametersOut |
Parameters profile for BC meta data - outbound messages.
This profile of Parameters is intended to force the inclusion of specific parameters that are common to all Operations. Below is a list with descriptions.
Parameter Name | Description |
---|---|
messageId | The unique id for the operation request. This is assigned by the sender of the operation request. |
messageDateTime | This field stores the date and time that the request was sent. |
requestMessageId | Each request will have a response. The response can be related back to the request (important for asynchronous operations) when the unique Id of the request is included in the response. |
sender | This is an identifier for the source of the request or response. |
enterer | The user identifier if required. |
Each request (Operation) and response (Bundle) must have these fields in a Parameter resource.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from MetadataParametersIn
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Parameters | MetadataParametersIn | |||
parameter | 3..* | BackboneElement | Operation Parameter | |
Slices for parameter | Content/Rules for all slices | |||
parameter:requestMessageId | S | 0..1 | BackboneElement | The messageID coming from the request |
name | S | 1..1 | string | Name from the definition Required Pattern: requestMessageId |
Slices for value[x] | 0..1 | string | If parameter is a data type Slice: Unordered, Open by type:$this | |
value[x]:valueString | S | 0..1 | string | If parameter is a data type |
resource | 0..0 | |||
part | 0..0 | |||
parameter:sender | S | 1..1 | BackboneElement | Operation Parameter |
name | S | 1..1 | string | Name from the definition Required Pattern: sender |
Slices for value[x] | 1..1 | Identifier | If parameter is a data type Slice: Unordered, Open by type:$this | |
value[x]:valueIdentifier | S | 1..1 | Identifier | If parameter is a data type |
resource | 0..0 | |||
part | 0..0 | |||
parameter:enterer | S | 0..1 | BackboneElement | Operation Parameter |
name | S | 1..1 | string | Name from the definition Required Pattern: enterer |
Slices for value[x] | 0..1 | Identifier | If parameter is a data type Slice: Unordered, Open by type:$this | |
value[x]:valueIdentifier | S | 0..1 | Identifier | If parameter is a data type |
resource | 0..0 | |||
part | 0..0 | |||
parameter:requestParameters | S | 0..1 | BackboneElement | Operation Parameter |
name | S | 1..1 | string | Name from the definition Required Pattern: requestParameters |
value[x] | 0..0 | |||
resource | S | 1..1 | Parameters | If parameter is a whole resource |
part | 0..0 | |||
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Parameters | 0..* | MetadataParametersIn | Operation Request or Response | |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
Slices for parameter | ΣC | 3..* | BackboneElement | Operation Parameter Slice: Unordered, Open by value:name inv-1: A parameter must have one and only one of (value, resource, part) |
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:messageId | SΣC | 1..1 | BackboneElement | Operation Parameter inv-1: A parameter must have one and only one of (value, resource, part) |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
name | SΣ | 1..1 | string | Name from the definition Required Pattern: messageId |
value[x] | SΣC | 1..1 | string | If parameter is a data type |
parameter:messageDateTime | SΣC | 1..1 | BackboneElement | Operation Parameter inv-1: A parameter must have one and only one of (value, resource, part) |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
name | SΣ | 1..1 | string | Name from the definition Required Pattern: messageDateTime |
Slices for value[x] | ΣC | 1..1 | dateTime | If parameter is a data type Slice: Unordered, Closed by type:$this |
value[x]:valueDateTime | SΣC | 1..1 | dateTime | If parameter is a data type |
parameter:identifiersOnly | SΣC | 0..1 | BackboneElement | Operation Parameter inv-1: A parameter must have one and only one of (value, resource, part) |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
name | SΣ | 1..1 | string | Name from the definition Required Pattern: identifiersOnly |
parameter:history | SΣC | 0..1 | BackboneElement | Operation Parameter inv-1: A parameter must have one and only one of (value, resource, part) |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
name | SΣ | 1..1 | string | Name from the definition Required Pattern: history |
parameter:requestMessageId | SΣC | 0..1 | BackboneElement | The messageID coming from the request inv-1: A parameter must have one and only one of (value, resource, part) |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
name | SΣ | 1..1 | string | Name from the definition Required Pattern: requestMessageId |
Slices for value[x] | ΣC | 0..1 | string | If parameter is a data type Slice: Unordered, Closed by type:$this |
value[x]:valueString | SΣC | 0..1 | string | If parameter is a data type |
parameter:sender | SΣC | 1..1 | BackboneElement | Operation Parameter inv-1: A parameter must have one and only one of (value, resource, part) |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
name | SΣ | 1..1 | string | Name from the definition Required Pattern: sender |
Slices for value[x] | ΣC | 1..1 | Identifier | If parameter is a data type Slice: Unordered, Closed by type:$this |
value[x]:valueIdentifier | SΣC | 1..1 | Identifier | If parameter is a data type |
parameter:enterer | SΣC | 0..1 | BackboneElement | Operation Parameter inv-1: A parameter must have one and only one of (value, resource, part) |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
name | SΣ | 1..1 | string | Name from the definition Required Pattern: enterer |
Slices for value[x] | ΣC | 0..1 | Identifier | If parameter is a data type Slice: Unordered, Closed by type:$this |
value[x]:valueIdentifier | SΣC | 0..1 | Identifier | If parameter is a data type |
parameter:requestParameters | SΣC | 0..1 | BackboneElement | Operation Parameter inv-1: A parameter must have one and only one of (value, resource, part) |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
name | SΣ | 1..1 | string | Name from the definition Required Pattern: requestParameters |
resource | SΣC | 1..1 | Parameters | If parameter is a whole resource |
Documentation for this format |
Id | Grade | Path(s) | Details | Requirements |
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:messageId, Parameters.parameter:messageDateTime, Parameters.parameter:identifiersOnly, Parameters.parameter:history, Parameters.parameter:requestMessageId, Parameters.parameter:sender, Parameters.parameter:enterer, Parameters.parameter:requestParameters | 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())) |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Parameters | 0..* | MetadataParametersIn | 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 | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
Slices for parameter | ΣC | 3..* | BackboneElement | Operation Parameter Slice: Unordered, Open by value:name inv-1: A parameter must have one and only one of (value, resource, part) | ||||
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:messageId | SΣC | 1..1 | BackboneElement | Operation Parameter inv-1: A parameter must have one and only one of (value, resource, part) | ||||
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 | SΣ | 1..1 | string | Name from the definition Required Pattern: messageId | ||||
value[x] | SΣC | 1..1 | string | If parameter is a data type | ||||
parameter:messageDateTime | SΣC | 1..1 | BackboneElement | Operation Parameter inv-1: A parameter must have one and only one of (value, resource, part) | ||||
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 | SΣ | 1..1 | string | Name from the definition Required Pattern: messageDateTime | ||||
Slices for value[x] | ΣC | 1..1 | dateTime | If parameter is a data type Slice: Unordered, Closed by type:$this | ||||
value[x]:valueDateTime | SΣC | 1..1 | dateTime | If parameter is a data type | ||||
parameter:identifiersOnly | SΣC | 0..1 | BackboneElement | Operation Parameter inv-1: A parameter must have one and only one of (value, resource, part) | ||||
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 | SΣ | 1..1 | string | Name from the definition Required Pattern: identifiersOnly | ||||
value[x] | ΣC | 0..1 | boolean | If parameter is a data type | ||||
parameter:history | SΣC | 0..1 | BackboneElement | Operation Parameter inv-1: A parameter must have one and only one of (value, resource, part) | ||||
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 | SΣ | 1..1 | string | Name from the definition Required Pattern: history | ||||
value[x] | ΣC | 0..1 | boolean | If parameter is a data type | ||||
parameter:requestMessageId | SΣC | 0..1 | BackboneElement | The messageID coming from the request inv-1: A parameter must have one and only one of (value, resource, part) | ||||
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 | SΣ | 1..1 | string | Name from the definition Required Pattern: requestMessageId | ||||
Slices for value[x] | ΣC | 0..1 | string | If parameter is a data type Slice: Unordered, Closed by type:$this | ||||
value[x]:valueString | SΣC | 0..1 | string | If parameter is a data type | ||||
parameter:sender | SΣC | 1..1 | BackboneElement | Operation Parameter inv-1: A parameter must have one and only one of (value, resource, part) | ||||
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 | SΣ | 1..1 | string | Name from the definition Required Pattern: sender | ||||
Slices for value[x] | ΣC | 1..1 | Identifier | If parameter is a data type Slice: Unordered, Closed by type:$this | ||||
value[x]:valueIdentifier | SΣC | 1..1 | Identifier | If parameter is a data type | ||||
parameter:enterer | SΣC | 0..1 | BackboneElement | Operation Parameter inv-1: A parameter must have one and only one of (value, resource, part) | ||||
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 | SΣ | 1..1 | string | Name from the definition Required Pattern: enterer | ||||
Slices for value[x] | ΣC | 0..1 | Identifier | If parameter is a data type Slice: Unordered, Closed by type:$this | ||||
value[x]:valueIdentifier | SΣC | 0..1 | Identifier | If parameter is a data type | ||||
parameter:requestParameters | SΣC | 0..1 | BackboneElement | Operation Parameter inv-1: A parameter must have one and only one of (value, resource, part) | ||||
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 | SΣ | 1..1 | string | Name from the definition Required Pattern: requestParameters | ||||
resource | SΣC | 1..1 | Parameters | If parameter is a whole resource | ||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
Parameters.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
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:messageId, Parameters.parameter:messageDateTime, Parameters.parameter:identifiersOnly, Parameters.parameter:history, Parameters.parameter:requestMessageId, Parameters.parameter:sender, Parameters.parameter:enterer, Parameters.parameter:requestParameters | 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 MetadataParametersIn
Differential View
This structure is derived from MetadataParametersIn
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Parameters | MetadataParametersIn | |||
parameter | 3..* | BackboneElement | Operation Parameter | |
Slices for parameter | Content/Rules for all slices | |||
parameter:requestMessageId | S | 0..1 | BackboneElement | The messageID coming from the request |
name | S | 1..1 | string | Name from the definition Required Pattern: requestMessageId |
Slices for value[x] | 0..1 | string | If parameter is a data type Slice: Unordered, Open by type:$this | |
value[x]:valueString | S | 0..1 | string | If parameter is a data type |
resource | 0..0 | |||
part | 0..0 | |||
parameter:sender | S | 1..1 | BackboneElement | Operation Parameter |
name | S | 1..1 | string | Name from the definition Required Pattern: sender |
Slices for value[x] | 1..1 | Identifier | If parameter is a data type Slice: Unordered, Open by type:$this | |
value[x]:valueIdentifier | S | 1..1 | Identifier | If parameter is a data type |
resource | 0..0 | |||
part | 0..0 | |||
parameter:enterer | S | 0..1 | BackboneElement | Operation Parameter |
name | S | 1..1 | string | Name from the definition Required Pattern: enterer |
Slices for value[x] | 0..1 | Identifier | If parameter is a data type Slice: Unordered, Open by type:$this | |
value[x]:valueIdentifier | S | 0..1 | Identifier | If parameter is a data type |
resource | 0..0 | |||
part | 0..0 | |||
parameter:requestParameters | S | 0..1 | BackboneElement | Operation Parameter |
name | S | 1..1 | string | Name from the definition Required Pattern: requestParameters |
value[x] | 0..0 | |||
resource | S | 1..1 | Parameters | If parameter is a whole resource |
part | 0..0 | |||
Documentation for this format |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Parameters | 0..* | MetadataParametersIn | Operation Request or Response | |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
Slices for parameter | ΣC | 3..* | BackboneElement | Operation Parameter Slice: Unordered, Open by value:name inv-1: A parameter must have one and only one of (value, resource, part) |
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:messageId | SΣC | 1..1 | BackboneElement | Operation Parameter inv-1: A parameter must have one and only one of (value, resource, part) |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
name | SΣ | 1..1 | string | Name from the definition Required Pattern: messageId |
value[x] | SΣC | 1..1 | string | If parameter is a data type |
parameter:messageDateTime | SΣC | 1..1 | BackboneElement | Operation Parameter inv-1: A parameter must have one and only one of (value, resource, part) |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
name | SΣ | 1..1 | string | Name from the definition Required Pattern: messageDateTime |
Slices for value[x] | ΣC | 1..1 | dateTime | If parameter is a data type Slice: Unordered, Closed by type:$this |
value[x]:valueDateTime | SΣC | 1..1 | dateTime | If parameter is a data type |
parameter:identifiersOnly | SΣC | 0..1 | BackboneElement | Operation Parameter inv-1: A parameter must have one and only one of (value, resource, part) |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
name | SΣ | 1..1 | string | Name from the definition Required Pattern: identifiersOnly |
parameter:history | SΣC | 0..1 | BackboneElement | Operation Parameter inv-1: A parameter must have one and only one of (value, resource, part) |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
name | SΣ | 1..1 | string | Name from the definition Required Pattern: history |
parameter:requestMessageId | SΣC | 0..1 | BackboneElement | The messageID coming from the request inv-1: A parameter must have one and only one of (value, resource, part) |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
name | SΣ | 1..1 | string | Name from the definition Required Pattern: requestMessageId |
Slices for value[x] | ΣC | 0..1 | string | If parameter is a data type Slice: Unordered, Closed by type:$this |
value[x]:valueString | SΣC | 0..1 | string | If parameter is a data type |
parameter:sender | SΣC | 1..1 | BackboneElement | Operation Parameter inv-1: A parameter must have one and only one of (value, resource, part) |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
name | SΣ | 1..1 | string | Name from the definition Required Pattern: sender |
Slices for value[x] | ΣC | 1..1 | Identifier | If parameter is a data type Slice: Unordered, Closed by type:$this |
value[x]:valueIdentifier | SΣC | 1..1 | Identifier | If parameter is a data type |
parameter:enterer | SΣC | 0..1 | BackboneElement | Operation Parameter inv-1: A parameter must have one and only one of (value, resource, part) |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
name | SΣ | 1..1 | string | Name from the definition Required Pattern: enterer |
Slices for value[x] | ΣC | 0..1 | Identifier | If parameter is a data type Slice: Unordered, Closed by type:$this |
value[x]:valueIdentifier | SΣC | 0..1 | Identifier | If parameter is a data type |
parameter:requestParameters | SΣC | 0..1 | BackboneElement | Operation Parameter inv-1: A parameter must have one and only one of (value, resource, part) |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
name | SΣ | 1..1 | string | Name from the definition Required Pattern: requestParameters |
resource | SΣC | 1..1 | Parameters | If parameter is a whole resource |
Documentation for this format |
Id | Grade | Path(s) | Details | Requirements |
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:messageId, Parameters.parameter:messageDateTime, Parameters.parameter:identifiersOnly, Parameters.parameter:history, Parameters.parameter:requestMessageId, Parameters.parameter:sender, Parameters.parameter:enterer, Parameters.parameter:requestParameters | 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())) |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Parameters | 0..* | MetadataParametersIn | 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 | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
Slices for parameter | ΣC | 3..* | BackboneElement | Operation Parameter Slice: Unordered, Open by value:name inv-1: A parameter must have one and only one of (value, resource, part) | ||||
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:messageId | SΣC | 1..1 | BackboneElement | Operation Parameter inv-1: A parameter must have one and only one of (value, resource, part) | ||||
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 | SΣ | 1..1 | string | Name from the definition Required Pattern: messageId | ||||
value[x] | SΣC | 1..1 | string | If parameter is a data type | ||||
parameter:messageDateTime | SΣC | 1..1 | BackboneElement | Operation Parameter inv-1: A parameter must have one and only one of (value, resource, part) | ||||
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 | SΣ | 1..1 | string | Name from the definition Required Pattern: messageDateTime | ||||
Slices for value[x] | ΣC | 1..1 | dateTime | If parameter is a data type Slice: Unordered, Closed by type:$this | ||||
value[x]:valueDateTime | SΣC | 1..1 | dateTime | If parameter is a data type | ||||
parameter:identifiersOnly | SΣC | 0..1 | BackboneElement | Operation Parameter inv-1: A parameter must have one and only one of (value, resource, part) | ||||
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 | SΣ | 1..1 | string | Name from the definition Required Pattern: identifiersOnly | ||||
value[x] | ΣC | 0..1 | boolean | If parameter is a data type | ||||
parameter:history | SΣC | 0..1 | BackboneElement | Operation Parameter inv-1: A parameter must have one and only one of (value, resource, part) | ||||
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 | SΣ | 1..1 | string | Name from the definition Required Pattern: history | ||||
value[x] | ΣC | 0..1 | boolean | If parameter is a data type | ||||
parameter:requestMessageId | SΣC | 0..1 | BackboneElement | The messageID coming from the request inv-1: A parameter must have one and only one of (value, resource, part) | ||||
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 | SΣ | 1..1 | string | Name from the definition Required Pattern: requestMessageId | ||||
Slices for value[x] | ΣC | 0..1 | string | If parameter is a data type Slice: Unordered, Closed by type:$this | ||||
value[x]:valueString | SΣC | 0..1 | string | If parameter is a data type | ||||
parameter:sender | SΣC | 1..1 | BackboneElement | Operation Parameter inv-1: A parameter must have one and only one of (value, resource, part) | ||||
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 | SΣ | 1..1 | string | Name from the definition Required Pattern: sender | ||||
Slices for value[x] | ΣC | 1..1 | Identifier | If parameter is a data type Slice: Unordered, Closed by type:$this | ||||
value[x]:valueIdentifier | SΣC | 1..1 | Identifier | If parameter is a data type | ||||
parameter:enterer | SΣC | 0..1 | BackboneElement | Operation Parameter inv-1: A parameter must have one and only one of (value, resource, part) | ||||
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 | SΣ | 1..1 | string | Name from the definition Required Pattern: enterer | ||||
Slices for value[x] | ΣC | 0..1 | Identifier | If parameter is a data type Slice: Unordered, Closed by type:$this | ||||
value[x]:valueIdentifier | SΣC | 0..1 | Identifier | If parameter is a data type | ||||
parameter:requestParameters | SΣC | 0..1 | BackboneElement | Operation Parameter inv-1: A parameter must have one and only one of (value, resource, part) | ||||
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 | SΣ | 1..1 | string | Name from the definition Required Pattern: requestParameters | ||||
resource | SΣC | 1..1 | Parameters | If parameter is a whole resource | ||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
Parameters.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
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:messageId, Parameters.parameter:messageDateTime, Parameters.parameter:identifiersOnly, Parameters.parameter:history, Parameters.parameter:requestMessageId, Parameters.parameter:sender, Parameters.parameter:enterer, Parameters.parameter:requestParameters | 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 MetadataParametersIn
Other representations of profile: CSV, Excel, Schematron