MedCom HomeCareObservation
1.1.0-trial-use - trial-use
MedCom HomeCareObservation
1.1.0-trial-use - trial-use
MedCom HomeCareObservation, published by MedCom. This guide is not an authorized publication; it is the continuous build for version 1.1.0-trial-use built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/medcomdk/dk_HomeCareObservations/ and changes regularly. See the Directory of published versions
| Official URL: http://medcomfhir.dk/ig/homecareobservation/StructureDefinition/medcom-homecareobservation-messageheader | Version: 1.1.0-trial-use | |||
| Draft as of 2025-08-26 | Computable Name: MedComHomeCareObservationMessageHeader | |||
MessageHeader for HomeCareObservation
This MessageDefinition profile defines the characteristics of a message that can be shared between systems, including the type of event that initiates the message, the content to be transmitted and what response(s), are permitted. This profile should not be included in the exchange of a HomeCareObservation message, but can be used to extract relevant information concerning the message, for usage in the VANSEnvelope. The MedComHomeCareObservationMessageHeader profile includes an required url to this profile in the element MessageHeader.definition.
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:   |
|---|---|---|---|---|
  MessageHeader |
0..* | MedComMessagingMessageHeader | A resource that describes a message that is exchanged between systems | |
  id |
SΣ | 1..1 | id | A unique identifier for each message. This identifier should be globally unique. |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
 text |
S | 0..1 | Narrative | A summary of the resource content. The narrative text shall always be included when exchanging a MedCom message. All MustSupport elements and extensions shall be included. This profile does not constrain the narrative in regard to content, language, or traceability to data elements |
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
 event[x] |
SΣ | 1..1 | Coding | The event element shall contain a value from MedComMessagingMessageTypes Binding: MedComMessagingMessageTypes (2.0.0-draft) (required) Required Pattern: At least the following |
 id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations | |
 system |
1..1 | uri | Identity of the terminology system Fixed Value: http://medcomfhir.dk/ig/terminology/CodeSystem/medcom-messaging-eventCodes | |
| version |
0..1 | string | Version of the system - if relevant | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: homecareobservation-message | |
| display |
0..1 | string | Representation defined by the system | |
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |
 code |
Σ | 1..1 | code | Symbol in syntax defined by the system |
 Slices for destination |
Σ | 1..* | BackboneElement | Message destination application(s) Slice: Unordered, Closed by value:$this.extension.value |
  destination:All Slices |
Content/Rules for all slices | |||
  modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
 endpoint |
Σ | 1..1 | url | Actual destination address or id |
  destination:primary |
Σ | 1..1 | BackboneElement | Message destination application(s) |
   Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
 extension:use |
S | 1..1 | (Complex) | MedComDestinationUseExtension URL: http://medcomfhir.dk/ig/messaging/StructureDefinition/medcom-messaging-destinationUseExtension |
 extension |
0..0 | |||
| url |
1..1 | uri | "http://medcomfhir.dk/ig/messaging/StructureDefinition/medcom-messaging-destinationUseExtension" | |
 value[x] |
1..1 | Coding | Value of extension Required Pattern: At least the following | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://medcomfhir.dk/ig/terminology/CodeSystem/medcom-messaging-destinationUse | |
| version |
0..1 | string | Version of the system - if relevant | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: primary | |
| display |
0..1 | string | Representation defined by the system | |
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |
| system |
Σ | 0..1 | uri | Identity of the terminology system Required Pattern: http://medcomfhir.dk/ig/terminology/CodeSystem/medcom-messaging-destinationUse |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| endpoint |
SΣ | 1..1 | url | Actual destination address or id |
  receiver |
SΣ | 1..1 | Reference(MedComMessagingRequesterOrganization) {b} | The primary reciever of the message |
| sender |
SΣ | 1..1 | Reference(MedComCoreProducerOrganization) {b} | The actual sender of the message |
| source |
SΣ | 1..1 | BackboneElement | Contains the information about the target for the Acknowledgement message. |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| endpoint |
SΣ | 1..1 | url | Actual message source address or id |
| focus |
Σ | 0..* | Reference(MedComHomeCareObservationDiagnosticReport) | The actual content of the message |
| definition |
SΣC | 1..1 | canonical(MessageDefinition) | Link to the definition for this message Constraints: medcom-hcobs-definition-url |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| MessageHeader.event[x] | required | Pattern Value: homecareobservation-messagehttp://medcomfhir.dk/ig/terminology/ValueSet/medcom-messaging-messageTypes|2.0.0-draft |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | MessageHeader | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | MessageHeader | If 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-4 | error | MessageHeader | If 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-5 | error | MessageHeader | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | MessageHeader | A resource should have narrative for robust management : text.`div`.exists() | |
| 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() | |
| medcom-hcobs-definition-url | error | MessageHeader.definition | SHALL reference a MedCom HomeCare Observation MessageDefinition whose canonical URL starts with
https://medcomfhir.dk/ig/messagedefinitions/MessageDefinition-MedComHomeCareObservationMessageDefinition1.—that is, any version 1.x of the message definition : matches('^http://medcomfhir.dk/ig/messagedefinitions/MessageDefinition/MedComHomeCareObservationMessageDefinition1[.][0-9]{1,2}$') |
This structure is derived from MedComMessagingMessageHeader
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| MessageHeader |
0..* | MedComMessagingMessageHeader | A resource that describes a message that is exchanged between systems | |
| id |
1..1 | id | A unique identifier for each message. This identifier should be globally unique. | |
| event[x] |
1..1 | Coding | The event element shall contain a value from MedComMessagingMessageTypes Required Pattern: At least the following | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://medcomfhir.dk/ig/terminology/CodeSystem/medcom-messaging-eventCodes | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: homecareobservation-message | |
| Slices for destination |
Content/Rules for all slices | |||
| destination:primary |
1..1 | BackboneElement | Message destination application(s) | |
| receiver |
1..1 | Reference(MedComMessagingRequesterOrganization) {b} | The primary reciever of the message | |
| destination:cc |
0..0 | |||
| sender |
1..1 | Reference(MedComCoreProducerOrganization) {b} | The actual sender of the message | |
| focus |
0..* | Reference(MedComHomeCareObservationDiagnosticReport) | The actual content of the message | |
| definition |
C | 1..1 | canonical(MessageDefinition) | Link to the definition for this message Constraints: medcom-hcobs-definition-url |
| Documentation for this format | ||||
| Id | Grade | Path(s) | Details | Requirements |
| medcom-hcobs-definition-url | error | MessageHeader.definition | SHALL reference a MedCom HomeCare Observation MessageDefinition whose canonical URL starts with
https://medcomfhir.dk/ig/messagedefinitions/MessageDefinition-MedComHomeCareObservationMessageDefinition1.—that is, any version 1.x of the message definition : matches('^http://medcomfhir.dk/ig/messagedefinitions/MessageDefinition/MedComHomeCareObservationMessageDefinition1[.][0-9]{1,2}$') |
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| MessageHeader |
0..* | MedComMessagingMessageHeader | A resource that describes a message that is exchanged between systems | |||||
| id |
SΣ | 1..1 | id | A unique identifier for each message. This identifier should be globally unique. | ||||
| 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.
| |||||
| text |
S | 0..1 | Narrative | A summary of the resource content. The narrative text shall always be included when exchanging a MedCom message. All MustSupport elements and extensions shall be included. This profile does not constrain the narrative in regard to content, language, or traceability to data elements | ||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| event[x] |
SΣ | 1..1 | Coding | The event element shall contain a value from MedComMessagingMessageTypes Binding: MedComMessagingMessageTypes (2.0.0-draft) (required) Required Pattern: At least the following | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://medcomfhir.dk/ig/terminology/CodeSystem/medcom-messaging-eventCodes | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: homecareobservation-message | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
Σ | 0..1 | uri | Identity of the terminology system | ||||
| version |
Σ | 0..1 | string | Version of the system - if relevant | ||||
| code |
Σ | 1..1 | code | Symbol in syntax defined by the system | ||||
| display |
Σ | 0..1 | string | Representation defined by the system | ||||
| userSelected |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
| Slices for destination |
Σ | 1..* | BackboneElement | Message destination application(s) Slice: Unordered, Closed by value:$this.extension.value | ||||
| destination: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 |
Σ | 0..1 | string | Name of system | ||||
| target |
Σ | 0..1 | Reference(Device) | Particular delivery destination within the destination | ||||
| endpoint |
Σ | 1..1 | url | Actual destination address or id | ||||
| receiver |
Σ | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | Intended "real-world" recipient for the data | ||||
| destination:primary |
Σ | 1..1 | BackboneElement | Message destination application(s) | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:use |
S | 1..1 | (Complex) | MedComDestinationUseExtension URL: http://medcomfhir.dk/ig/messaging/StructureDefinition/medcom-messaging-destinationUseExtension | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..0 | |||||||
| url |
1..1 | uri | "http://medcomfhir.dk/ig/messaging/StructureDefinition/medcom-messaging-destinationUseExtension" | |||||
| value[x] |
1..1 | Coding | Value of extension Required Pattern: At least the following | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://medcomfhir.dk/ig/terminology/CodeSystem/medcom-messaging-destinationUse | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: primary | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
Σ | 0..1 | uri | Identity of the terminology system Required Pattern: http://medcomfhir.dk/ig/terminology/CodeSystem/medcom-messaging-destinationUse | ||||
| version |
Σ | 0..1 | string | Version of the system - if relevant | ||||
| code |
Σ | 0..1 | code | Symbol in syntax defined by the system | ||||
| display |
Σ | 0..1 | string | Representation defined by the system | ||||
| userSelected |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| name |
Σ | 0..1 | string | Name of system | ||||
| target |
Σ | 0..1 | Reference(Device) | Particular delivery destination within the destination | ||||
| endpoint |
SΣ | 1..1 | url | Actual destination address or id | ||||
| receiver |
SΣ | 1..1 | Reference(MedComMessagingRequesterOrganization) {b} | The primary reciever of the message | ||||
| sender |
SΣ | 1..1 | Reference(MedComCoreProducerOrganization) {b} | The actual sender of the message | ||||
| enterer |
Σ | 0..1 | Reference(Practitioner | PractitionerRole) | The source of the data entry | ||||
| author |
Σ | 0..1 | Reference(Practitioner | PractitionerRole) | The source of the decision | ||||
| source |
SΣ | 1..1 | BackboneElement | Contains the information about the target for the Acknowledgement message. | ||||
| 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 |
Σ | 0..1 | string | Name of system | ||||
| software |
Σ | 0..1 | string | Name of software running the system | ||||
| version |
Σ | 0..1 | string | Version of software running | ||||
| contact |
Σ | 0..1 | ContactPoint | Human contact for problems | ||||
| endpoint |
SΣ | 1..1 | url | Actual message source address or id | ||||
| responsible |
Σ | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | Final responsibility for event | ||||
| reason |
Σ | 0..1 | CodeableConcept | Cause of event Binding: ExampleMessageReasonCodes (example): Reason for event occurrence. | ||||
| response |
Σ | 0..1 | BackboneElement | If this is a reply to prior message | ||||
| 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 | ||||
| identifier |
Σ | 1..1 | id | Id of original message | ||||
| code |
Σ | 1..1 | code | ok | transient-error | fatal-error Binding: ResponseType (required): The kind of response to a message. | ||||
| details |
Σ | 0..1 | Reference(OperationOutcome) | Specific list of hints/warnings/errors | ||||
| focus |
Σ | 0..* | Reference(MedComHomeCareObservationDiagnosticReport) | The actual content of the message | ||||
| definition |
SΣC | 1..1 | canonical(MessageDefinition) | Link to the definition for this message Constraints: medcom-hcobs-definition-url | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| MessageHeader.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesFrom the FHIR Standard
| ||||
| MessageHeader.event[x] | required | Pattern Value: homecareobservation-messagehttp://medcomfhir.dk/ig/terminology/ValueSet/medcom-messaging-messageTypes|2.0.0-draft | ||||
| MessageHeader.reason | example | ExampleMessageReasonCodeshttp://hl7.org/fhir/ValueSet/message-reason-encounterFrom the FHIR Standard | ||||
| MessageHeader.response.code | required | ResponseTypehttp://hl7.org/fhir/ValueSet/response-code|4.0.1From the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | MessageHeader | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | MessageHeader | If 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-4 | error | MessageHeader | If 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-5 | error | MessageHeader | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | MessageHeader | A resource should have narrative for robust management : text.`div`.exists() | |
| 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() | |
| medcom-hcobs-definition-url | error | MessageHeader.definition | SHALL reference a MedCom HomeCare Observation MessageDefinition whose canonical URL starts with
https://medcomfhir.dk/ig/messagedefinitions/MessageDefinition-MedComHomeCareObservationMessageDefinition1.—that is, any version 1.x of the message definition : matches('^http://medcomfhir.dk/ig/messagedefinitions/MessageDefinition/MedComHomeCareObservationMessageDefinition1[.][0-9]{1,2}$') |
This structure is derived from MedComMessagingMessageHeader
Summary
Mandatory: 1 element
Prohibited: 1 element
Structures
This structure refers to these other structures:
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| MessageHeader |
0..* | MedComMessagingMessageHeader | A resource that describes a message that is exchanged between systems | |
| id |
SΣ | 1..1 | id | A unique identifier for each message. This identifier should be globally unique. |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
| text |
S | 0..1 | Narrative | A summary of the resource content. The narrative text shall always be included when exchanging a MedCom message. All MustSupport elements and extensions shall be included. This profile does not constrain the narrative in regard to content, language, or traceability to data elements |
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| event[x] |
SΣ | 1..1 | Coding | The event element shall contain a value from MedComMessagingMessageTypes Binding: MedComMessagingMessageTypes (2.0.0-draft) (required) Required Pattern: At least the following |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://medcomfhir.dk/ig/terminology/CodeSystem/medcom-messaging-eventCodes | |
| version |
0..1 | string | Version of the system - if relevant | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: homecareobservation-message | |
| display |
0..1 | string | Representation defined by the system | |
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |
| code |
Σ | 1..1 | code | Symbol in syntax defined by the system |
| Slices for destination |
Σ | 1..* | BackboneElement | Message destination application(s) Slice: Unordered, Closed by value:$this.extension.value |
| destination:All Slices |
Content/Rules for all slices | |||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| endpoint |
Σ | 1..1 | url | Actual destination address or id |
| destination:primary |
Σ | 1..1 | BackboneElement | Message destination application(s) |
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:use |
S | 1..1 | (Complex) | MedComDestinationUseExtension URL: http://medcomfhir.dk/ig/messaging/StructureDefinition/medcom-messaging-destinationUseExtension |
| extension |
0..0 | |||
| url |
1..1 | uri | "http://medcomfhir.dk/ig/messaging/StructureDefinition/medcom-messaging-destinationUseExtension" | |
| value[x] |
1..1 | Coding | Value of extension Required Pattern: At least the following | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://medcomfhir.dk/ig/terminology/CodeSystem/medcom-messaging-destinationUse | |
| version |
0..1 | string | Version of the system - if relevant | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: primary | |
| display |
0..1 | string | Representation defined by the system | |
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |
| system |
Σ | 0..1 | uri | Identity of the terminology system Required Pattern: http://medcomfhir.dk/ig/terminology/CodeSystem/medcom-messaging-destinationUse |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| endpoint |
SΣ | 1..1 | url | Actual destination address or id |
| receiver |
SΣ | 1..1 | Reference(MedComMessagingRequesterOrganization) {b} | The primary reciever of the message |
| sender |
SΣ | 1..1 | Reference(MedComCoreProducerOrganization) {b} | The actual sender of the message |
| source |
SΣ | 1..1 | BackboneElement | Contains the information about the target for the Acknowledgement message. |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| endpoint |
SΣ | 1..1 | url | Actual message source address or id |
| focus |
Σ | 0..* | Reference(MedComHomeCareObservationDiagnosticReport) | The actual content of the message |
| definition |
SΣC | 1..1 | canonical(MessageDefinition) | Link to the definition for this message Constraints: medcom-hcobs-definition-url |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| MessageHeader.event[x] | required | Pattern Value: homecareobservation-messagehttp://medcomfhir.dk/ig/terminology/ValueSet/medcom-messaging-messageTypes|2.0.0-draft |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | MessageHeader | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | MessageHeader | If 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-4 | error | MessageHeader | If 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-5 | error | MessageHeader | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | MessageHeader | A resource should have narrative for robust management : text.`div`.exists() | |
| 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() | |
| medcom-hcobs-definition-url | error | MessageHeader.definition | SHALL reference a MedCom HomeCare Observation MessageDefinition whose canonical URL starts with
https://medcomfhir.dk/ig/messagedefinitions/MessageDefinition-MedComHomeCareObservationMessageDefinition1.—that is, any version 1.x of the message definition : matches('^http://medcomfhir.dk/ig/messagedefinitions/MessageDefinition/MedComHomeCareObservationMessageDefinition1[.][0-9]{1,2}$') |
Differential View
This structure is derived from MedComMessagingMessageHeader
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| MessageHeader |
0..* | MedComMessagingMessageHeader | A resource that describes a message that is exchanged between systems | |
| id |
1..1 | id | A unique identifier for each message. This identifier should be globally unique. | |
| event[x] |
1..1 | Coding | The event element shall contain a value from MedComMessagingMessageTypes Required Pattern: At least the following | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://medcomfhir.dk/ig/terminology/CodeSystem/medcom-messaging-eventCodes | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: homecareobservation-message | |
| Slices for destination |
Content/Rules for all slices | |||
| destination:primary |
1..1 | BackboneElement | Message destination application(s) | |
| receiver |
1..1 | Reference(MedComMessagingRequesterOrganization) {b} | The primary reciever of the message | |
| destination:cc |
0..0 | |||
| sender |
1..1 | Reference(MedComCoreProducerOrganization) {b} | The actual sender of the message | |
| focus |
0..* | Reference(MedComHomeCareObservationDiagnosticReport) | The actual content of the message | |
| definition |
C | 1..1 | canonical(MessageDefinition) | Link to the definition for this message Constraints: medcom-hcobs-definition-url |
| Documentation for this format | ||||
| Id | Grade | Path(s) | Details | Requirements |
| medcom-hcobs-definition-url | error | MessageHeader.definition | SHALL reference a MedCom HomeCare Observation MessageDefinition whose canonical URL starts with
https://medcomfhir.dk/ig/messagedefinitions/MessageDefinition-MedComHomeCareObservationMessageDefinition1.—that is, any version 1.x of the message definition : matches('^http://medcomfhir.dk/ig/messagedefinitions/MessageDefinition/MedComHomeCareObservationMessageDefinition1[.][0-9]{1,2}$') |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| MessageHeader |
0..* | MedComMessagingMessageHeader | A resource that describes a message that is exchanged between systems | |||||
| id |
SΣ | 1..1 | id | A unique identifier for each message. This identifier should be globally unique. | ||||
| 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.
| |||||
| text |
S | 0..1 | Narrative | A summary of the resource content. The narrative text shall always be included when exchanging a MedCom message. All MustSupport elements and extensions shall be included. This profile does not constrain the narrative in regard to content, language, or traceability to data elements | ||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| event[x] |
SΣ | 1..1 | Coding | The event element shall contain a value from MedComMessagingMessageTypes Binding: MedComMessagingMessageTypes (2.0.0-draft) (required) Required Pattern: At least the following | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://medcomfhir.dk/ig/terminology/CodeSystem/medcom-messaging-eventCodes | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: homecareobservation-message | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
Σ | 0..1 | uri | Identity of the terminology system | ||||
| version |
Σ | 0..1 | string | Version of the system - if relevant | ||||
| code |
Σ | 1..1 | code | Symbol in syntax defined by the system | ||||
| display |
Σ | 0..1 | string | Representation defined by the system | ||||
| userSelected |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
| Slices for destination |
Σ | 1..* | BackboneElement | Message destination application(s) Slice: Unordered, Closed by value:$this.extension.value | ||||
| destination: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 |
Σ | 0..1 | string | Name of system | ||||
| target |
Σ | 0..1 | Reference(Device) | Particular delivery destination within the destination | ||||
| endpoint |
Σ | 1..1 | url | Actual destination address or id | ||||
| receiver |
Σ | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | Intended "real-world" recipient for the data | ||||
| destination:primary |
Σ | 1..1 | BackboneElement | Message destination application(s) | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:use |
S | 1..1 | (Complex) | MedComDestinationUseExtension URL: http://medcomfhir.dk/ig/messaging/StructureDefinition/medcom-messaging-destinationUseExtension | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..0 | |||||||
| url |
1..1 | uri | "http://medcomfhir.dk/ig/messaging/StructureDefinition/medcom-messaging-destinationUseExtension" | |||||
| value[x] |
1..1 | Coding | Value of extension Required Pattern: At least the following | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://medcomfhir.dk/ig/terminology/CodeSystem/medcom-messaging-destinationUse | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: primary | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system |
Σ | 0..1 | uri | Identity of the terminology system Required Pattern: http://medcomfhir.dk/ig/terminology/CodeSystem/medcom-messaging-destinationUse | ||||
| version |
Σ | 0..1 | string | Version of the system - if relevant | ||||
| code |
Σ | 0..1 | code | Symbol in syntax defined by the system | ||||
| display |
Σ | 0..1 | string | Representation defined by the system | ||||
| userSelected |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| name |
Σ | 0..1 | string | Name of system | ||||
| target |
Σ | 0..1 | Reference(Device) | Particular delivery destination within the destination | ||||
| endpoint |
SΣ | 1..1 | url | Actual destination address or id | ||||
| receiver |
SΣ | 1..1 | Reference(MedComMessagingRequesterOrganization) {b} | The primary reciever of the message | ||||
| sender |
SΣ | 1..1 | Reference(MedComCoreProducerOrganization) {b} | The actual sender of the message | ||||
| enterer |
Σ | 0..1 | Reference(Practitioner | PractitionerRole) | The source of the data entry | ||||
| author |
Σ | 0..1 | Reference(Practitioner | PractitionerRole) | The source of the decision | ||||
| source |
SΣ | 1..1 | BackboneElement | Contains the information about the target for the Acknowledgement message. | ||||
| 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 |
Σ | 0..1 | string | Name of system | ||||
| software |
Σ | 0..1 | string | Name of software running the system | ||||
| version |
Σ | 0..1 | string | Version of software running | ||||
| contact |
Σ | 0..1 | ContactPoint | Human contact for problems | ||||
| endpoint |
SΣ | 1..1 | url | Actual message source address or id | ||||
| responsible |
Σ | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | Final responsibility for event | ||||
| reason |
Σ | 0..1 | CodeableConcept | Cause of event Binding: ExampleMessageReasonCodes (example): Reason for event occurrence. | ||||
| response |
Σ | 0..1 | BackboneElement | If this is a reply to prior message | ||||
| 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 | ||||
| identifier |
Σ | 1..1 | id | Id of original message | ||||
| code |
Σ | 1..1 | code | ok | transient-error | fatal-error Binding: ResponseType (required): The kind of response to a message. | ||||
| details |
Σ | 0..1 | Reference(OperationOutcome) | Specific list of hints/warnings/errors | ||||
| focus |
Σ | 0..* | Reference(MedComHomeCareObservationDiagnosticReport) | The actual content of the message | ||||
| definition |
SΣC | 1..1 | canonical(MessageDefinition) | Link to the definition for this message Constraints: medcom-hcobs-definition-url | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| MessageHeader.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesFrom the FHIR Standard
| ||||
| MessageHeader.event[x] | required | Pattern Value: homecareobservation-messagehttp://medcomfhir.dk/ig/terminology/ValueSet/medcom-messaging-messageTypes|2.0.0-draft | ||||
| MessageHeader.reason | example | ExampleMessageReasonCodeshttp://hl7.org/fhir/ValueSet/message-reason-encounterFrom the FHIR Standard | ||||
| MessageHeader.response.code | required | ResponseTypehttp://hl7.org/fhir/ValueSet/response-code|4.0.1From the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | MessageHeader | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | MessageHeader | If 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-4 | error | MessageHeader | If 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-5 | error | MessageHeader | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | MessageHeader | A resource should have narrative for robust management : text.`div`.exists() | |
| 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() | |
| medcom-hcobs-definition-url | error | MessageHeader.definition | SHALL reference a MedCom HomeCare Observation MessageDefinition whose canonical URL starts with
https://medcomfhir.dk/ig/messagedefinitions/MessageDefinition-MedComHomeCareObservationMessageDefinition1.—that is, any version 1.x of the message definition : matches('^http://medcomfhir.dk/ig/messagedefinitions/MessageDefinition/MedComHomeCareObservationMessageDefinition1[.][0-9]{1,2}$') |
This structure is derived from MedComMessagingMessageHeader
Summary
Mandatory: 1 element
Prohibited: 1 element
Structures
This structure refers to these other structures:
Other representations of profile: CSV, Excel, Schematron