0.2.3 - ci-build

HealthDataReceipt - Local Development build (v0.2.3). See the Directory of published versions

Resource Profile: PDR Message Header

Official URL: https://github.com/Open-Health-Manager/patient-data-receipt-ig/StructureDefinition/PatientDataReceiptHeader Version: 0.2.3
Active as of 2022-10-19 Computable Name: PatientDataReceiptHeader

Message Header for a Patient Data Receipt.

Usage:

Formal Views of Profile Content

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

This structure is derived from MessageHeader

NameFlagsCard.TypeDescription & Constraintsdoco
.. MessageHeader 0..*MessageHeaderA resource that describes a message that is exchanged between systems
... event[x] 1..1uriCode for the event this message represents or link to event definition
Slice: Unordered, Open by type:$this
... eventUri S1..1uriCode for the event this message represents or link to event definition
Required Pattern: urn:mitre:healthmanager:pdr
... source S1..1BackboneElementMessage source application
.... endpoint S1..1urlActual message source address or id
.... focus:patient S1..1Reference(Resource)The actual content of the message
.... focus:tableOfContents S0..1Reference(Resource)The actual content of the message
.... focus:otherResources 0..*Reference(Resource)The actual content of the message

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. MessageHeader 0..*MessageHeaderA resource that describes a message that is exchanged between systems
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for event[x] Σ1..1uriCode for the event this message represents or link to event definition
Slice: Unordered, Closed by type:$this
Binding: MessageEvent (example): One of the message events defined as part of this version of FHIR.

.... event[x]:eventUri SΣ1..1uriCode for the event this message represents or link to event definition
Binding: MessageEvent (example): One of the message events defined as part of this version of FHIR.


Required Pattern: urn:mitre:healthmanager:pdr
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... endpoint SΣ1..1urlActual message source address or id
... Slices for focus Σ1..*Reference(Resource)The actual content of the message
Slice: Unordered, Open by type:resolve()
.... focus:patient SΣ1..1Reference(Resource)The actual content of the message
.... focus:tableOfContents SΣ0..1Reference(Resource)The actual content of the message
.... focus:otherResources Σ0..*Reference(Resource)The actual content of the message

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
MessageHeader.event[x]exampleMessageEvent
MessageHeader.event[x]:eventUriexamplePattern: urn:mitre:healthmanager:pdr

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorMessageHeaderIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorMessageHeaderIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorMessageHeaderIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorMessageHeaderIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceMessageHeaderA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. MessageHeader 0..*MessageHeaderA resource that describes a message that is exchanged between systems
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for event[x] Σ1..1uriCode for the event this message represents or link to event definition
Slice: Unordered, Closed by type:$this
Binding: MessageEvent (example): One of the message events defined as part of this version of FHIR.

.... event[x]:eventUri SΣ1..1uriCode for the event this message represents or link to event definition
Binding: MessageEvent (example): One of the message events defined as part of this version of FHIR.


Required Pattern: urn:mitre:healthmanager:pdr
... destination Σ0..*BackboneElementMessage destination application(s)
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... name Σ0..1stringName of system
.... target Σ0..1Reference(Device)Particular delivery destination within the destination
.... endpoint Σ1..1urlActual destination address or id
.... receiver Σ0..1Reference(Practitioner | PractitionerRole | Organization)Intended "real-world" recipient for the data
... sender Σ0..1Reference(Practitioner | PractitionerRole | Organization)Real world sender of the message
... enterer Σ0..1Reference(Practitioner | PractitionerRole)The source of the data entry
... author Σ0..1Reference(Practitioner | PractitionerRole)The source of the decision
... source SΣ1..1BackboneElementMessage source application
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... name Σ0..1stringName of system
.... software Σ0..1stringName of software running the system
.... version Σ0..1stringVersion of software running
.... contact Σ0..1ContactPointHuman contact for problems
.... endpoint SΣ1..1urlActual message source address or id
... responsible Σ0..1Reference(Practitioner | PractitionerRole | Organization)Final responsibility for event
... reason Σ0..1CodeableConceptCause of event
Binding: ExampleMessageReasonCodes (example): Reason for event occurrence.

... response Σ0..1BackboneElementIf this is a reply to prior message
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... identifier Σ1..1idId of original message
.... code Σ1..1codeok | transient-error | fatal-error
Binding: ResponseType (required): The kind of response to a message.

.... details Σ0..1Reference(OperationOutcome)Specific list of hints/warnings/errors
... Slices for focus Σ1..*Reference(Resource)The actual content of the message
Slice: Unordered, Open by type:resolve()
.... focus:patient SΣ1..1Reference(Resource)The actual content of the message
.... focus:tableOfContents SΣ0..1Reference(Resource)The actual content of the message
.... focus:otherResources Σ0..*Reference(Resource)The actual content of the message
... definition Σ0..1canonical(MessageDefinition)Link to the definition for this message

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
MessageHeader.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
MessageHeader.event[x]exampleMessageEvent
MessageHeader.event[x]:eventUriexamplePattern: urn:mitre:healthmanager:pdr
MessageHeader.reasonexampleExampleMessageReasonCodes
MessageHeader.response.coderequiredResponseType

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from MessageHeader

Summary

Mandatory: 3 elements
Must-Support: 5 elements

Slices

This structure defines the following Slices:

  • The element MessageHeader.event[x] is sliced based on the value of type:$this
  • The element MessageHeader.focus is sliced based on the value of type:resolve()

Differential View

This structure is derived from MessageHeader

NameFlagsCard.TypeDescription & Constraintsdoco
.. MessageHeader 0..*MessageHeaderA resource that describes a message that is exchanged between systems
... event[x] 1..1uriCode for the event this message represents or link to event definition
Slice: Unordered, Open by type:$this
... eventUri S1..1uriCode for the event this message represents or link to event definition
Required Pattern: urn:mitre:healthmanager:pdr
... source S1..1BackboneElementMessage source application
.... endpoint S1..1urlActual message source address or id
.... focus:patient S1..1Reference(Resource)The actual content of the message
.... focus:tableOfContents S0..1Reference(Resource)The actual content of the message
.... focus:otherResources 0..*Reference(Resource)The actual content of the message

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. MessageHeader 0..*MessageHeaderA resource that describes a message that is exchanged between systems
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for event[x] Σ1..1uriCode for the event this message represents or link to event definition
Slice: Unordered, Closed by type:$this
Binding: MessageEvent (example): One of the message events defined as part of this version of FHIR.

.... event[x]:eventUri SΣ1..1uriCode for the event this message represents or link to event definition
Binding: MessageEvent (example): One of the message events defined as part of this version of FHIR.


Required Pattern: urn:mitre:healthmanager:pdr
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... endpoint SΣ1..1urlActual message source address or id
... Slices for focus Σ1..*Reference(Resource)The actual content of the message
Slice: Unordered, Open by type:resolve()
.... focus:patient SΣ1..1Reference(Resource)The actual content of the message
.... focus:tableOfContents SΣ0..1Reference(Resource)The actual content of the message
.... focus:otherResources Σ0..*Reference(Resource)The actual content of the message

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
MessageHeader.event[x]exampleMessageEvent
MessageHeader.event[x]:eventUriexamplePattern: urn:mitre:healthmanager:pdr

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorMessageHeaderIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorMessageHeaderIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorMessageHeaderIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorMessageHeaderIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceMessageHeaderA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. MessageHeader 0..*MessageHeaderA resource that describes a message that is exchanged between systems
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for event[x] Σ1..1uriCode for the event this message represents or link to event definition
Slice: Unordered, Closed by type:$this
Binding: MessageEvent (example): One of the message events defined as part of this version of FHIR.

.... event[x]:eventUri SΣ1..1uriCode for the event this message represents or link to event definition
Binding: MessageEvent (example): One of the message events defined as part of this version of FHIR.


Required Pattern: urn:mitre:healthmanager:pdr
... destination Σ0..*BackboneElementMessage destination application(s)
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... name Σ0..1stringName of system
.... target Σ0..1Reference(Device)Particular delivery destination within the destination
.... endpoint Σ1..1urlActual destination address or id
.... receiver Σ0..1Reference(Practitioner | PractitionerRole | Organization)Intended "real-world" recipient for the data
... sender Σ0..1Reference(Practitioner | PractitionerRole | Organization)Real world sender of the message
... enterer Σ0..1Reference(Practitioner | PractitionerRole)The source of the data entry
... author Σ0..1Reference(Practitioner | PractitionerRole)The source of the decision
... source SΣ1..1BackboneElementMessage source application
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... name Σ0..1stringName of system
.... software Σ0..1stringName of software running the system
.... version Σ0..1stringVersion of software running
.... contact Σ0..1ContactPointHuman contact for problems
.... endpoint SΣ1..1urlActual message source address or id
... responsible Σ0..1Reference(Practitioner | PractitionerRole | Organization)Final responsibility for event
... reason Σ0..1CodeableConceptCause of event
Binding: ExampleMessageReasonCodes (example): Reason for event occurrence.

... response Σ0..1BackboneElementIf this is a reply to prior message
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... identifier Σ1..1idId of original message
.... code Σ1..1codeok | transient-error | fatal-error
Binding: ResponseType (required): The kind of response to a message.

.... details Σ0..1Reference(OperationOutcome)Specific list of hints/warnings/errors
... Slices for focus Σ1..*Reference(Resource)The actual content of the message
Slice: Unordered, Open by type:resolve()
.... focus:patient SΣ1..1Reference(Resource)The actual content of the message
.... focus:tableOfContents SΣ0..1Reference(Resource)The actual content of the message
.... focus:otherResources Σ0..*Reference(Resource)The actual content of the message
... definition Σ0..1canonical(MessageDefinition)Link to the definition for this message

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
MessageHeader.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
MessageHeader.event[x]exampleMessageEvent
MessageHeader.event[x]:eventUriexamplePattern: urn:mitre:healthmanager:pdr
MessageHeader.reasonexampleExampleMessageReasonCodes
MessageHeader.response.coderequiredResponseType

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from MessageHeader

Summary

Mandatory: 3 elements
Must-Support: 5 elements

Slices

This structure defines the following Slices:

  • The element MessageHeader.event[x] is sliced based on the value of type:$this
  • The element MessageHeader.focus is sliced based on the value of type:resolve()

 

Other representations of profile: CSV, Excel, Schematron