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-parameter-async-response | Version: 1.0.0 | |||
| Draft as of 2026-03-25 | Computable Name: MetadataParametersAsync | |||
Parameters profile for BC meta data - async messages.
This profile of Parameters is intended for asynchronous responses. Each asynchronous response message must have these fields in a Parameter resource. It also has a list of specific parameters that are common to all Operations, and common to all type of Messages (inbound, outbound, async). Below is a list of these parameters with descriptions.
| Parameter Name | Description |
|---|---|
| messageId | The unique id for the operation request. This is assigned by the sender of the operation request. |
| messageDateTime | DEPRECATED and Removed. This field was to store the date and time that the request was sent by the original sender |
| 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. |
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | MetadataParametersIn | Operation Request or Response | |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
ΣC | 2..* | BackboneElement | Operation Parameter Slice: Unordered, Open by value:name Constraints: inv-1 |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
Σ | 1..1 | string | Name from the definition |
![]() ![]() ![]() |
SΣC | 1..1 | BackboneElement | Operation Parameter Constraints: inv-1 |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Name from the definition Required Pattern: messageId |
![]() ![]() ![]() ![]() |
SΣC | 1..1 | string | If parameter is a data type |
![]() ![]() ![]() |
SΣC | 0..1 | BackboneElement | Operation Parameter Constraints: inv-1 |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Name from the definition Required Pattern: identifiersOnly |
![]() ![]() ![]() |
SΣC | 0..1 | BackboneElement | Operation Parameter Constraints: inv-1 |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Name from the definition Required Pattern: history |
![]() ![]() ![]() |
SΣC | 0..1 | BackboneElement | The messageID coming from the request Constraints: inv-1 |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Name from the definition Required Pattern: requestMessageId |
![]() ![]() ![]() ![]() |
ΣC | 0..1 | string | If parameter is a data type Slice: Unordered, Closed by type:$this |
![]() ![]() ![]() ![]() ![]() |
SΣC | 0..1 | string | If parameter is a data type |
![]() ![]() ![]() |
SΣC | 1..1 | BackboneElement | Operation Parameter Constraints: inv-1 |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Name from the definition Required Pattern: sender |
![]() ![]() ![]() ![]() |
ΣC | 1..1 | Identifier | If parameter is a data type Slice: Unordered, Closed by type:$this |
![]() ![]() ![]() ![]() ![]() |
SΣC | 1..1 | Identifier | If parameter is a data type |
![]() ![]() ![]() |
SΣC | 0..1 | BackboneElement | Operation Parameter Constraints: inv-1 |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Name from the definition Required Pattern: enterer |
![]() ![]() ![]() ![]() |
ΣC | 0..1 | Identifier | If parameter is a data type Slice: Unordered, Closed by type:$this |
![]() ![]() ![]() ![]() ![]() |
SΣC | 0..1 | Identifier | If parameter is a data type |
![]() ![]() ![]() |
SΣC | 0..1 | BackboneElement | Operation Parameter Constraints: inv-1 |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Name from the definition Required Pattern: requestParameters |
![]() ![]() ![]() ![]() |
SΣC | 1..1 | Parameters | If parameter is a whole resource |
Documentation for this format | ||||
| 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:messageId, 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
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
MetadataParametersIn | |||
![]() ![]() |
2..* | BackboneElement | Operation Parameter | |
![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() |
S | 0..1 | BackboneElement | The messageID coming from the request |
![]() ![]() ![]() ![]() |
S | 1..1 | string | Name from the definition Required Pattern: requestMessageId |
![]() ![]() ![]() ![]() |
0..1 | string | If parameter is a data type Slice: Unordered, Open by type:$this | |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | string | If parameter is a data type |
![]() ![]() ![]() ![]() |
0..0 | If parameter is a whole resource | ||
![]() ![]() ![]() ![]() |
0..0 | Named part of a multi-part parameter | ||
![]() ![]() ![]() |
S | 1..1 | BackboneElement | Operation Parameter |
![]() ![]() ![]() ![]() |
S | 1..1 | string | Name from the definition Required Pattern: sender |
![]() ![]() ![]() ![]() |
1..1 | Identifier | If parameter is a data type Slice: Unordered, Open by type:$this | |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | Identifier | If parameter is a data type |
![]() ![]() ![]() ![]() |
0..0 | If parameter is a whole resource | ||
![]() ![]() ![]() ![]() |
0..0 | Named part of a multi-part parameter | ||
![]() ![]() ![]() |
S | 0..1 | BackboneElement | Operation Parameter |
![]() ![]() ![]() ![]() |
S | 1..1 | string | Name from the definition Required Pattern: enterer |
![]() ![]() ![]() ![]() |
0..1 | Identifier | If parameter is a data type Slice: Unordered, Open by type:$this | |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | Identifier | If parameter is a data type |
![]() ![]() ![]() ![]() |
0..0 | If parameter is a whole resource | ||
![]() ![]() ![]() ![]() |
0..0 | Named part of a multi-part parameter | ||
![]() ![]() ![]() |
S | 0..1 | BackboneElement | Operation Parameter |
![]() ![]() ![]() ![]() |
S | 1..1 | string | Name from the definition Required Pattern: requestParameters |
![]() ![]() ![]() ![]() |
0..0 | If parameter is a data type | ||
![]() ![]() ![]() ![]() |
S | 1..1 | Parameters | If parameter is a whole resource |
![]() ![]() ![]() ![]() |
0..0 | Named part of a multi-part parameter | ||
Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | MetadataParametersIn | Operation Request or Response | |||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() |
ΣC | 2..* | BackboneElement | Operation Parameter Slice: Unordered, Open by value:name Constraints: inv-1 | ||||
![]() ![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | string | Name from the definition | ||||
![]() ![]() ![]() ![]() |
ΣC | 0..1 | If parameter is a data type | |||||
![]() ![]() ![]() ![]() ![]() |
base64Binary | |||||||
![]() ![]() ![]() ![]() ![]() |
boolean | |||||||
![]() ![]() ![]() ![]() ![]() |
canonical(Any) | |||||||
![]() ![]() ![]() ![]() ![]() |
code | |||||||
![]() ![]() ![]() ![]() ![]() |
date | |||||||
![]() ![]() ![]() ![]() ![]() |
dateTime | |||||||
![]() ![]() ![]() ![]() ![]() |
decimal | |||||||
![]() ![]() ![]() ![]() ![]() |
id | |||||||
![]() ![]() ![]() ![]() ![]() |
instant | |||||||
![]() ![]() ![]() ![]() ![]() |
integer | |||||||
![]() ![]() ![]() ![]() ![]() |
markdown | |||||||
![]() ![]() ![]() ![]() ![]() |
oid | |||||||
![]() ![]() ![]() ![]() ![]() |
positiveInt | |||||||
![]() ![]() ![]() ![]() ![]() |
string | |||||||
![]() ![]() ![]() ![]() ![]() |
time | |||||||
![]() ![]() ![]() ![]() ![]() |
unsignedInt | |||||||
![]() ![]() ![]() ![]() ![]() |
uri | |||||||
![]() ![]() ![]() ![]() ![]() |
url | |||||||
![]() ![]() ![]() ![]() ![]() |
uuid | |||||||
![]() ![]() ![]() ![]() ![]() |
Address | |||||||
![]() ![]() ![]() ![]() ![]() |
Age | |||||||
![]() ![]() ![]() ![]() ![]() |
Annotation | |||||||
![]() ![]() ![]() ![]() ![]() |
Attachment | |||||||
![]() ![]() ![]() ![]() ![]() |
CodeableConcept | |||||||
![]() ![]() ![]() ![]() ![]() |
Coding | |||||||
![]() ![]() ![]() ![]() ![]() |
ContactPoint | |||||||
![]() ![]() ![]() ![]() ![]() |
Count | |||||||
![]() ![]() ![]() ![]() ![]() |
Distance | |||||||
![]() ![]() ![]() ![]() ![]() |
Duration | |||||||
![]() ![]() ![]() ![]() ![]() |
HumanName | |||||||
![]() ![]() ![]() ![]() ![]() |
Identifier | |||||||
![]() ![]() ![]() ![]() ![]() |
Money | |||||||
![]() ![]() ![]() ![]() ![]() |
Period | |||||||
![]() ![]() ![]() ![]() ![]() |
Quantity | |||||||
![]() ![]() ![]() ![]() ![]() |
Range | |||||||
![]() ![]() ![]() ![]() ![]() |
Ratio | |||||||
![]() ![]() ![]() ![]() ![]() |
Reference(Any) | |||||||
![]() ![]() ![]() ![]() ![]() |
SampledData | |||||||
![]() ![]() ![]() ![]() ![]() |
Signature | |||||||
![]() ![]() ![]() ![]() ![]() |
Timing | |||||||
![]() ![]() ![]() ![]() ![]() |
ContactDetail | |||||||
![]() ![]() ![]() ![]() ![]() |
Contributor | |||||||
![]() ![]() ![]() ![]() ![]() |
DataRequirement | |||||||
![]() ![]() ![]() ![]() ![]() |
Expression | |||||||
![]() ![]() ![]() ![]() ![]() |
ParameterDefinition | |||||||
![]() ![]() ![]() ![]() ![]() |
RelatedArtifact | |||||||
![]() ![]() ![]() ![]() ![]() |
TriggerDefinition | |||||||
![]() ![]() ![]() ![]() ![]() |
UsageContext | |||||||
![]() ![]() ![]() ![]() ![]() |
Dosage | |||||||
![]() ![]() ![]() ![]() ![]() |
Meta | |||||||
![]() ![]() ![]() ![]() |
ΣC | 0..1 | Resource | If parameter is a whole resource | ||||
![]() ![]() ![]() ![]() |
Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter | ||||
![]() ![]() ![]() |
SΣC | 1..1 | BackboneElement | Operation Parameter Constraints: inv-1 | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Name from the definition Required Pattern: messageId | ||||
![]() ![]() ![]() ![]() |
SΣC | 1..1 | string | If parameter is a data type | ||||
![]() ![]() ![]() |
SΣC | 0..1 | BackboneElement | Operation Parameter Constraints: inv-1 | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Name from the definition Required Pattern: identifiersOnly | ||||
![]() ![]() ![]() ![]() |
ΣC | 0..1 | boolean | If parameter is a data type | ||||
![]() ![]() ![]() |
SΣC | 0..1 | BackboneElement | Operation Parameter Constraints: inv-1 | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Name from the definition Required Pattern: history | ||||
![]() ![]() ![]() ![]() |
ΣC | 0..1 | boolean | If parameter is a data type | ||||
![]() ![]() ![]() |
SΣC | 0..1 | BackboneElement | The messageID coming from the request Constraints: inv-1 | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Name from the definition Required Pattern: requestMessageId | ||||
![]() ![]() ![]() ![]() |
ΣC | 0..1 | string | If parameter is a data type Slice: Unordered, Closed by type:$this | ||||
![]() ![]() ![]() ![]() ![]() |
SΣC | 0..1 | string | If parameter is a data type | ||||
![]() ![]() ![]() |
SΣC | 1..1 | BackboneElement | Operation Parameter Constraints: inv-1 | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Name from the definition Required Pattern: sender | ||||
![]() ![]() ![]() ![]() |
ΣC | 1..1 | Identifier | If parameter is a data type Slice: Unordered, Closed by type:$this | ||||
![]() ![]() ![]() ![]() ![]() |
SΣC | 1..1 | Identifier | If parameter is a data type | ||||
![]() ![]() ![]() |
SΣC | 0..1 | BackboneElement | Operation Parameter Constraints: inv-1 | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Name from the definition Required Pattern: enterer | ||||
![]() ![]() ![]() ![]() |
ΣC | 0..1 | Identifier | If parameter is a data type Slice: Unordered, Closed by type:$this | ||||
![]() ![]() ![]() ![]() ![]() |
SΣC | 0..1 | Identifier | If parameter is a data type | ||||
![]() ![]() ![]() |
SΣC | 0..1 | BackboneElement | Operation Parameter Constraints: inv-1 | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Name from the definition Required Pattern: requestParameters | ||||
![]() ![]() ![]() ![]() |
SΣC | 1..1 | Parameters | If parameter is a whole resource | ||||
Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Parameters.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| 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:messageId, 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
Summary
Mandatory: 3 elements(1 nested mandatory element)
Must-Support: 12 elements
Prohibited: 8 elements
Slices
This structure defines the following Slices:
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | MetadataParametersIn | Operation Request or Response | |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
ΣC | 2..* | BackboneElement | Operation Parameter Slice: Unordered, Open by value:name Constraints: inv-1 |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
Σ | 1..1 | string | Name from the definition |
![]() ![]() ![]() |
SΣC | 1..1 | BackboneElement | Operation Parameter Constraints: inv-1 |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Name from the definition Required Pattern: messageId |
![]() ![]() ![]() ![]() |
SΣC | 1..1 | string | If parameter is a data type |
![]() ![]() ![]() |
SΣC | 0..1 | BackboneElement | Operation Parameter Constraints: inv-1 |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Name from the definition Required Pattern: identifiersOnly |
![]() ![]() ![]() |
SΣC | 0..1 | BackboneElement | Operation Parameter Constraints: inv-1 |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Name from the definition Required Pattern: history |
![]() ![]() ![]() |
SΣC | 0..1 | BackboneElement | The messageID coming from the request Constraints: inv-1 |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Name from the definition Required Pattern: requestMessageId |
![]() ![]() ![]() ![]() |
ΣC | 0..1 | string | If parameter is a data type Slice: Unordered, Closed by type:$this |
![]() ![]() ![]() ![]() ![]() |
SΣC | 0..1 | string | If parameter is a data type |
![]() ![]() ![]() |
SΣC | 1..1 | BackboneElement | Operation Parameter Constraints: inv-1 |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Name from the definition Required Pattern: sender |
![]() ![]() ![]() ![]() |
ΣC | 1..1 | Identifier | If parameter is a data type Slice: Unordered, Closed by type:$this |
![]() ![]() ![]() ![]() ![]() |
SΣC | 1..1 | Identifier | If parameter is a data type |
![]() ![]() ![]() |
SΣC | 0..1 | BackboneElement | Operation Parameter Constraints: inv-1 |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Name from the definition Required Pattern: enterer |
![]() ![]() ![]() ![]() |
ΣC | 0..1 | Identifier | If parameter is a data type Slice: Unordered, Closed by type:$this |
![]() ![]() ![]() ![]() ![]() |
SΣC | 0..1 | Identifier | If parameter is a data type |
![]() ![]() ![]() |
SΣC | 0..1 | BackboneElement | Operation Parameter Constraints: inv-1 |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Name from the definition Required Pattern: requestParameters |
![]() ![]() ![]() ![]() |
SΣC | 1..1 | Parameters | If parameter is a whole resource |
Documentation for this format | ||||
| 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:messageId, 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()))
|
Differential View
This structure is derived from MetadataParametersIn
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
MetadataParametersIn | |||
![]() ![]() |
2..* | BackboneElement | Operation Parameter | |
![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() |
S | 0..1 | BackboneElement | The messageID coming from the request |
![]() ![]() ![]() ![]() |
S | 1..1 | string | Name from the definition Required Pattern: requestMessageId |
![]() ![]() ![]() ![]() |
0..1 | string | If parameter is a data type Slice: Unordered, Open by type:$this | |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | string | If parameter is a data type |
![]() ![]() ![]() ![]() |
0..0 | If parameter is a whole resource | ||
![]() ![]() ![]() ![]() |
0..0 | Named part of a multi-part parameter | ||
![]() ![]() ![]() |
S | 1..1 | BackboneElement | Operation Parameter |
![]() ![]() ![]() ![]() |
S | 1..1 | string | Name from the definition Required Pattern: sender |
![]() ![]() ![]() ![]() |
1..1 | Identifier | If parameter is a data type Slice: Unordered, Open by type:$this | |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | Identifier | If parameter is a data type |
![]() ![]() ![]() ![]() |
0..0 | If parameter is a whole resource | ||
![]() ![]() ![]() ![]() |
0..0 | Named part of a multi-part parameter | ||
![]() ![]() ![]() |
S | 0..1 | BackboneElement | Operation Parameter |
![]() ![]() ![]() ![]() |
S | 1..1 | string | Name from the definition Required Pattern: enterer |
![]() ![]() ![]() ![]() |
0..1 | Identifier | If parameter is a data type Slice: Unordered, Open by type:$this | |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | Identifier | If parameter is a data type |
![]() ![]() ![]() ![]() |
0..0 | If parameter is a whole resource | ||
![]() ![]() ![]() ![]() |
0..0 | Named part of a multi-part parameter | ||
![]() ![]() ![]() |
S | 0..1 | BackboneElement | Operation Parameter |
![]() ![]() ![]() ![]() |
S | 1..1 | string | Name from the definition Required Pattern: requestParameters |
![]() ![]() ![]() ![]() |
0..0 | If parameter is a data type | ||
![]() ![]() ![]() ![]() |
S | 1..1 | Parameters | If parameter is a whole resource |
![]() ![]() ![]() ![]() |
0..0 | Named part of a multi-part parameter | ||
Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | MetadataParametersIn | Operation Request or Response | |||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() |
ΣC | 2..* | BackboneElement | Operation Parameter Slice: Unordered, Open by value:name Constraints: inv-1 | ||||
![]() ![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | string | Name from the definition | ||||
![]() ![]() ![]() ![]() |
ΣC | 0..1 | If parameter is a data type | |||||
![]() ![]() ![]() ![]() ![]() |
base64Binary | |||||||
![]() ![]() ![]() ![]() ![]() |
boolean | |||||||
![]() ![]() ![]() ![]() ![]() |
canonical(Any) | |||||||
![]() ![]() ![]() ![]() ![]() |
code | |||||||
![]() ![]() ![]() ![]() ![]() |
date | |||||||
![]() ![]() ![]() ![]() ![]() |
dateTime | |||||||
![]() ![]() ![]() ![]() ![]() |
decimal | |||||||
![]() ![]() ![]() ![]() ![]() |
id | |||||||
![]() ![]() ![]() ![]() ![]() |
instant | |||||||
![]() ![]() ![]() ![]() ![]() |
integer | |||||||
![]() ![]() ![]() ![]() ![]() |
markdown | |||||||
![]() ![]() ![]() ![]() ![]() |
oid | |||||||
![]() ![]() ![]() ![]() ![]() |
positiveInt | |||||||
![]() ![]() ![]() ![]() ![]() |
string | |||||||
![]() ![]() ![]() ![]() ![]() |
time | |||||||
![]() ![]() ![]() ![]() ![]() |
unsignedInt | |||||||
![]() ![]() ![]() ![]() ![]() |
uri | |||||||
![]() ![]() ![]() ![]() ![]() |
url | |||||||
![]() ![]() ![]() ![]() ![]() |
uuid | |||||||
![]() ![]() ![]() ![]() ![]() |
Address | |||||||
![]() ![]() ![]() ![]() ![]() |
Age | |||||||
![]() ![]() ![]() ![]() ![]() |
Annotation | |||||||
![]() ![]() ![]() ![]() ![]() |
Attachment | |||||||
![]() ![]() ![]() ![]() ![]() |
CodeableConcept | |||||||
![]() ![]() ![]() ![]() ![]() |
Coding | |||||||
![]() ![]() ![]() ![]() ![]() |
ContactPoint | |||||||
![]() ![]() ![]() ![]() ![]() |
Count | |||||||
![]() ![]() ![]() ![]() ![]() |
Distance | |||||||
![]() ![]() ![]() ![]() ![]() |
Duration | |||||||
![]() ![]() ![]() ![]() ![]() |
HumanName | |||||||
![]() ![]() ![]() ![]() ![]() |
Identifier | |||||||
![]() ![]() ![]() ![]() ![]() |
Money | |||||||
![]() ![]() ![]() ![]() ![]() |
Period | |||||||
![]() ![]() ![]() ![]() ![]() |
Quantity | |||||||
![]() ![]() ![]() ![]() ![]() |
Range | |||||||
![]() ![]() ![]() ![]() ![]() |
Ratio | |||||||
![]() ![]() ![]() ![]() ![]() |
Reference(Any) | |||||||
![]() ![]() ![]() ![]() ![]() |
SampledData | |||||||
![]() ![]() ![]() ![]() ![]() |
Signature | |||||||
![]() ![]() ![]() ![]() ![]() |
Timing | |||||||
![]() ![]() ![]() ![]() ![]() |
ContactDetail | |||||||
![]() ![]() ![]() ![]() ![]() |
Contributor | |||||||
![]() ![]() ![]() ![]() ![]() |
DataRequirement | |||||||
![]() ![]() ![]() ![]() ![]() |
Expression | |||||||
![]() ![]() ![]() ![]() ![]() |
ParameterDefinition | |||||||
![]() ![]() ![]() ![]() ![]() |
RelatedArtifact | |||||||
![]() ![]() ![]() ![]() ![]() |
TriggerDefinition | |||||||
![]() ![]() ![]() ![]() ![]() |
UsageContext | |||||||
![]() ![]() ![]() ![]() ![]() |
Dosage | |||||||
![]() ![]() ![]() ![]() ![]() |
Meta | |||||||
![]() ![]() ![]() ![]() |
ΣC | 0..1 | Resource | If parameter is a whole resource | ||||
![]() ![]() ![]() ![]() |
Σ | 0..* | See parameter (Parameters) | Named part of a multi-part parameter | ||||
![]() ![]() ![]() |
SΣC | 1..1 | BackboneElement | Operation Parameter Constraints: inv-1 | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Name from the definition Required Pattern: messageId | ||||
![]() ![]() ![]() ![]() |
SΣC | 1..1 | string | If parameter is a data type | ||||
![]() ![]() ![]() |
SΣC | 0..1 | BackboneElement | Operation Parameter Constraints: inv-1 | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Name from the definition Required Pattern: identifiersOnly | ||||
![]() ![]() ![]() ![]() |
ΣC | 0..1 | boolean | If parameter is a data type | ||||
![]() ![]() ![]() |
SΣC | 0..1 | BackboneElement | Operation Parameter Constraints: inv-1 | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Name from the definition Required Pattern: history | ||||
![]() ![]() ![]() ![]() |
ΣC | 0..1 | boolean | If parameter is a data type | ||||
![]() ![]() ![]() |
SΣC | 0..1 | BackboneElement | The messageID coming from the request Constraints: inv-1 | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Name from the definition Required Pattern: requestMessageId | ||||
![]() ![]() ![]() ![]() |
ΣC | 0..1 | string | If parameter is a data type Slice: Unordered, Closed by type:$this | ||||
![]() ![]() ![]() ![]() ![]() |
SΣC | 0..1 | string | If parameter is a data type | ||||
![]() ![]() ![]() |
SΣC | 1..1 | BackboneElement | Operation Parameter Constraints: inv-1 | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Name from the definition Required Pattern: sender | ||||
![]() ![]() ![]() ![]() |
ΣC | 1..1 | Identifier | If parameter is a data type Slice: Unordered, Closed by type:$this | ||||
![]() ![]() ![]() ![]() ![]() |
SΣC | 1..1 | Identifier | If parameter is a data type | ||||
![]() ![]() ![]() |
SΣC | 0..1 | BackboneElement | Operation Parameter Constraints: inv-1 | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Name from the definition Required Pattern: enterer | ||||
![]() ![]() ![]() ![]() |
ΣC | 0..1 | Identifier | If parameter is a data type Slice: Unordered, Closed by type:$this | ||||
![]() ![]() ![]() ![]() ![]() |
SΣC | 0..1 | Identifier | If parameter is a data type | ||||
![]() ![]() ![]() |
SΣC | 0..1 | BackboneElement | Operation Parameter Constraints: inv-1 | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | Name from the definition Required Pattern: requestParameters | ||||
![]() ![]() ![]() ![]() |
SΣC | 1..1 | Parameters | If parameter is a whole resource | ||||
Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Parameters.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| 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:messageId, 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
Summary
Mandatory: 3 elements(1 nested mandatory element)
Must-Support: 12 elements
Prohibited: 8 elements
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron