BC Client Registry FHIR Implementation Guide
1.0.0 - Build CI Canada flag

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

Resource Profile: MetadataParametersIn

Official URL: http://hlth.gov.bc.ca/fhir/client/StructureDefinition/bc-metadata-parameters-in Version: 1.0.0
Active as of 2026-03-25 Computable Name: MetadataParametersIn

Parameters profile for BC meta data - incoming messages. This profile is also intended to force the inclusion of specific parameters for the related Parameters.

This profile of Parameters is intended for inbound messages. Each request (Operation) 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

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 1..* 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:messageId SΣC 1..1 BackboneElement Operation Parameter
Constraints: inv-1
..... 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:identifiersOnly SΣC 0..1 BackboneElement Operation Parameter
Constraints: inv-1
..... 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
Constraints: inv-1
..... 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

doco Documentation for this format

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:messageId, Parameters.parameter:identifiersOnly, Parameters.parameter:history 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 Parameters
... Slices for parameter 1..* BackboneElement Operation Parameter
Slice: Unordered, Open by value:name
.... parameter:messageId S 1..1 BackboneElement Operation Parameter
..... name S 1..1 string Name from the definition
Required Pattern: messageId
..... value[x] S 1..1 string If parameter is a data type
..... resource 0..0 If parameter is a whole resource
..... part 0..0 Named part of a multi-part parameter
.... parameter:identifiersOnly S 0..1 BackboneElement Operation Parameter
..... name S 1..1 string Name from the definition
Required Pattern: identifiersOnly
..... value[x] 0..1 boolean If parameter is a data type
..... resource 0..0 If parameter is a whole resource
..... part 0..0 Named part of a multi-part parameter
.... parameter:history S 0..1 BackboneElement Operation Parameter
..... name S 1..1 string Name from the definition
Required Pattern: history
..... value[x] 0..1 boolean If parameter is a data type
..... resource 0..0 If parameter is a whole resource
..... part 0..0 Named part of a multi-part parameter

doco Documentation for this format
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 1..* 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:messageId SΣ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 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:identifiersOnly SΣ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 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
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 SΣ 1..1 string Name from the definition
Required Pattern: history
..... value[x] ΣC 0..1 boolean If parameter is a data type

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Parameters.language Base preferred Common Languages 📍4.0.1 FHIR Std.

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:messageId, Parameters.parameter:identifiersOnly, Parameters.parameter:history 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: 3 elements
Must-Support: 7 elements
Prohibited: 6 elements

Slices

This structure defines the following Slices:

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

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 1..* 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:messageId SΣC 1..1 BackboneElement Operation Parameter
Constraints: inv-1
..... 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:identifiersOnly SΣC 0..1 BackboneElement Operation Parameter
Constraints: inv-1
..... 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
Constraints: inv-1
..... 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

doco Documentation for this format

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:messageId, Parameters.parameter:identifiersOnly, Parameters.parameter:history 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 Parameters
... Slices for parameter 1..* BackboneElement Operation Parameter
Slice: Unordered, Open by value:name
.... parameter:messageId S 1..1 BackboneElement Operation Parameter
..... name S 1..1 string Name from the definition
Required Pattern: messageId
..... value[x] S 1..1 string If parameter is a data type
..... resource 0..0 If parameter is a whole resource
..... part 0..0 Named part of a multi-part parameter
.... parameter:identifiersOnly S 0..1 BackboneElement Operation Parameter
..... name S 1..1 string Name from the definition
Required Pattern: identifiersOnly
..... value[x] 0..1 boolean If parameter is a data type
..... resource 0..0 If parameter is a whole resource
..... part 0..0 Named part of a multi-part parameter
.... parameter:history S 0..1 BackboneElement Operation Parameter
..... name S 1..1 string Name from the definition
Required Pattern: history
..... value[x] 0..1 boolean If parameter is a data type
..... resource 0..0 If parameter is a whole resource
..... part 0..0 Named part of a multi-part parameter

doco Documentation for this format

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 1..* 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:messageId SΣ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 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:identifiersOnly SΣ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 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
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 SΣ 1..1 string Name from the definition
Required Pattern: history
..... value[x] ΣC 0..1 boolean If parameter is a data type

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Parameters.language Base preferred Common Languages 📍4.0.1 FHIR Std.

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:messageId, Parameters.parameter:identifiersOnly, Parameters.parameter:history 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: 3 elements
Must-Support: 7 elements
Prohibited: 6 elements

Slices

This structure defines the following Slices:

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

 

Other representations of profile: CSV, Excel, Schematron