DK MedCom HospitalNotification
3.0.1 - Release
DK MedCom HospitalNotification
3.0.1 - Release
DK MedCom HospitalNotification, published by MedCom. This guide is not an authorized publication; it is the continuous build for version 3.0.1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/medcomdk/dk-medcom-hospitalnotification/ and changes regularly. See the Directory of published versions
| Official URL: http://medcomfhir.dk/ig/hospitalnotification/StructureDefinition/medcom-hospitalNotification-message | Version: 3.0.1 | |||
| Active as of 2024-10-02 | Computable Name: MedComHospitalNotificationMessage | |||
A message for a HospitalNotification. The message is triggered as patients are admitted, onleave or has finished a hospital stay in order to notify the relevant Municipalicy home care
This profile is the root profile of MedCom HospitalNotification message. This profile is inherited from the MedComMessagingMessage. The following figure represent the profiles that shall be included in a MedCom FHIR HospitalNotification message.
The Bundle containing the HospitalNotification message is selfcontained, why it shall contain one instance of the MedComHospitalNotificationMessageHeader. By convention the cardinality is shown as 0..*.
Please refer to the tab "Snapshot Table(Must support)" below for the definition of the required content of a MedComHospitalNotificationMessage.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from MedComMessagingMessage
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Bundle |
C | 0..* | MedComMessagingMessage | Contains a collection of resources medcom-hospitalNotification-1: The message header shall conform to medcom-hospitalNotification-messageHeader profile medcom-hospitalNotification-2: Entry shall contain exactly one patient resource medcom-hospitalNotification-3: All provenance resources shall contain activities from medcom-hospitalNotification-messageActivities valueset medcom-hospitalNotification-4: The system of Patient.identifier shall be 'urn:oid:1.2.208.176.1.2', which represents an official Danish CPR-number medcom-hospitalNotification-5: The receiver of a HospitalNotification shall always be a primary receiver. |
  id |
1..1 | id | A unique identifier for a bundle. The element must be updated with a new value each time a new message is sent. | |
| timestamp |
1..1 | instant | Holds information about when a bundle is created. | |
 entry |
0..* | BackboneElement | Message content (MedComHospitalNotificationMessageHeader, MedComMessagingOrganization, MedComMessagingProvenance, MedComHospitalNotificationEncounter, MedComCorePatient) - Open | |
| Documentation for this format | ||||
| Id | Grade | Path(s) | Details | Requirements |
| medcom-hospitalNotification-1 | error | Bundle | The message header shall conform to medcom-hospitalNotification-messageHeader profile : entry.ofType(MessageHeader).all(resource.conformsTo('http://medcomfhir.dk/fhir/hospitalnotification/StructureDefinition/medcom-hospitalNotification-messageHeader')) | |
| medcom-hospitalNotification-2 | error | Bundle | Entry shall contain exactly one patient resource : entry.where(resource.is(Patient)).count() = 1 | |
| medcom-hospitalNotification-3 | error | Bundle | All provenance resources shall contain activities from medcom-hospitalNotification-messageActivities valueset : entry.ofType(Provenance).all(resource.activity.memberOf('http://medcomfhir.dk/fhir/dk-medcom-terminology/ValueSet/medcom-hospitalNotification-messageActivities')) | |
| medcom-hospitalNotification-4 | error | Bundle | The system of Patient.identifier shall be 'urn:oid:1.2.208.176.1.2', which represents an official Danish CPR-number : entry.resource.ofType(Patient).identifier.system = 'urn:oid:1.2.208.176.1.2' | |
| medcom-hospitalNotification-5 | error | Bundle | The receiver of a HospitalNotification shall always be a primary receiver. : Bundle.entry.resource.ofType(MessageHeader).destination.extension.value.code = 'primary' |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Bundle |
C | 0..* | MedComMessagingMessage | Contains a collection of resources bdl-1: total only when a search or history bdl-2: entry.search only when a search bdl-3: entry.request mandatory for batch/transaction/history, otherwise prohibited bdl-4: entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited bdl-7: FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles) bdl-9: A document must have an identifier with a system and a value bdl-10: A document must have a date bdl-11: A document must have a Composition as the first resource bdl-12: A message must have a MessageHeader as the first resource medcom-messaging-1: The MessageHeader resource shall conform to medcom-messaging-messageHeader profile medcom-messaging-2: There shall be at least one Provenance resource in a MedCom message medcom-hospitalNotification-1: The message header shall conform to medcom-hospitalNotification-messageHeader profile medcom-hospitalNotification-2: Entry shall contain exactly one patient resource medcom-hospitalNotification-3: All provenance resources shall contain activities from medcom-hospitalNotification-messageActivities valueset medcom-hospitalNotification-4: The system of Patient.identifier shall be 'urn:oid:1.2.208.176.1.2', which represents an official Danish CPR-number medcom-hospitalNotification-5: The receiver of a HospitalNotification shall always be a primary receiver. |
 id |
SΣ | 1..1 | id | A unique identifier for a bundle. The element must be updated with a new value each time a new message is sent. |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
| type |
SΣ | 1..1 | code | Always message Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used. Required Pattern: message |
| timestamp |
SΣ | 1..1 | instant | Holds information about when a bundle is created. |
  entry |
SΣC | 0..* | BackboneElement | Message content (MedComHospitalNotificationMessageHeader, MedComMessagingOrganization, MedComMessagingProvenance, MedComHospitalNotificationEncounter, MedComCorePatient) - Open bdl-5: must be a resource unless there's a request or response bdl-8: fullUrl cannot be a version specific reference This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type |
  modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| resource |
SΣ | 0..1 | Resource | Each MedCom message shall contain a MedComMessagingMessageHeader and MedComMessagingProvenance. Please refer to invariant medcom-messaging-1, medcom-messaging-2, and medcom-messaging-3. |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Bundle.type | required | Pattern: messagehttp://hl7.org/fhir/ValueSet/bundle-type|4.0.1from the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| bdl-1 | error | Bundle | total only when a search or history : total.empty() or (type = 'searchset') or (type = 'history') | |
| bdl-2 | error | Bundle | entry.search only when a search : entry.search.empty() or (type = 'searchset') | |
| bdl-3 | error | Bundle | entry.request mandatory for batch/transaction/history, otherwise prohibited : entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history')) | |
| bdl-4 | error | Bundle | entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited : entry.all(response.exists() = (%resource.type = 'batch-response' or %resource.type = 'transaction-response' or %resource.type = 'history')) | |
| bdl-5 | error | Bundle.entry | must be a resource unless there's a request or response : resource.exists() or request.exists() or response.exists() | |
| bdl-7 | error | Bundle | FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles) : (type = 'history') or entry.where(fullUrl.exists()).select(fullUrl&resource.meta.versionId).isDistinct() | |
| bdl-8 | error | Bundle.entry | fullUrl cannot be a version specific reference : fullUrl.contains('/_history/').not() | |
| bdl-9 | error | Bundle | A document must have an identifier with a system and a value : type = 'document' implies (identifier.system.exists() and identifier.value.exists()) | |
| bdl-10 | error | Bundle | A document must have a date : type = 'document' implies (timestamp.hasValue()) | |
| bdl-11 | error | Bundle | A document must have a Composition as the first resource : type = 'document' implies entry.first().resource.is(Composition) | |
| bdl-12 | error | Bundle | A message must have a MessageHeader as the first resource : type = 'message' implies entry.first().resource.is(MessageHeader) | |
| 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-hospitalNotification-1 | error | Bundle | The message header shall conform to medcom-hospitalNotification-messageHeader profile : entry.ofType(MessageHeader).all(resource.conformsTo('http://medcomfhir.dk/fhir/hospitalnotification/StructureDefinition/medcom-hospitalNotification-messageHeader')) | |
| medcom-hospitalNotification-2 | error | Bundle | Entry shall contain exactly one patient resource : entry.where(resource.is(Patient)).count() = 1 | |
| medcom-hospitalNotification-3 | error | Bundle | All provenance resources shall contain activities from medcom-hospitalNotification-messageActivities valueset : entry.ofType(Provenance).all(resource.activity.memberOf('http://medcomfhir.dk/fhir/dk-medcom-terminology/ValueSet/medcom-hospitalNotification-messageActivities')) | |
| medcom-hospitalNotification-4 | error | Bundle | The system of Patient.identifier shall be 'urn:oid:1.2.208.176.1.2', which represents an official Danish CPR-number : entry.resource.ofType(Patient).identifier.system = 'urn:oid:1.2.208.176.1.2' | |
| medcom-hospitalNotification-5 | error | Bundle | The receiver of a HospitalNotification shall always be a primary receiver. : Bundle.entry.resource.ofType(MessageHeader).destination.extension.value.code = 'primary' | |
| medcom-messaging-1 | error | Bundle | The MessageHeader resource shall conform to medcom-messaging-messageHeader profile : entry[0].resource.conformsTo('http://medcomfhir.dk/ig/messaging/StructureDefinition/medcom-messaging-messageHeader') | |
| medcom-messaging-2 | error | Bundle | There shall be at least one Provenance resource in a MedCom message : entry.resource.ofType(Provenance).exists() |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Bundle |
C | 0..* | MedComMessagingMessage | Contains a collection of resources bdl-1: total only when a search or history bdl-2: entry.search only when a search bdl-3: entry.request mandatory for batch/transaction/history, otherwise prohibited bdl-4: entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited bdl-7: FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles) bdl-9: A document must have an identifier with a system and a value bdl-10: A document must have a date bdl-11: A document must have a Composition as the first resource bdl-12: A message must have a MessageHeader as the first resource medcom-messaging-1: The MessageHeader resource shall conform to medcom-messaging-messageHeader profile medcom-messaging-2: There shall be at least one Provenance resource in a MedCom message medcom-hospitalNotification-1: The message header shall conform to medcom-hospitalNotification-messageHeader profile medcom-hospitalNotification-2: Entry shall contain exactly one patient resource medcom-hospitalNotification-3: All provenance resources shall contain activities from medcom-hospitalNotification-messageActivities valueset medcom-hospitalNotification-4: The system of Patient.identifier shall be 'urn:oid:1.2.208.176.1.2', which represents an official Danish CPR-number medcom-hospitalNotification-5: The receiver of a HospitalNotification shall always be a primary receiver. | ||||
| id |
SΣ | 1..1 | id | A unique identifier for a bundle. The element must be updated with a new value each time a new message is sent. | ||||
| 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.
| |||||
| identifier |
Σ | 0..1 | Identifier | Persistent identifier for the bundle | ||||
| type |
SΣ | 1..1 | code | Always message Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used. Required Pattern: message | ||||
| timestamp |
SΣ | 1..1 | instant | Holds information about when a bundle is created. | ||||
| total |
ΣC | 0..1 | unsignedInt | If search, the total number of matches | ||||
 link |
Σ | 0..* | BackboneElement | Links related to this Bundle | ||||
 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 | ||||
| relation |
Σ | 1..1 | string | See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1 | ||||
| url |
Σ | 1..1 | uri | Reference details for the link | ||||
| entry |
SΣC | 0..* | BackboneElement | Message content (MedComHospitalNotificationMessageHeader, MedComMessagingOrganization, MedComMessagingProvenance, MedComHospitalNotificationEncounter, MedComCorePatient) - Open bdl-5: must be a resource unless there's a request or response bdl-8: fullUrl cannot be a version specific reference This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type | ||||
| 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 | ||||
| link |
Σ | 0..* | See link (Bundle) | Links related to this entry | ||||
| fullUrl |
Σ | 0..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||
| resource |
SΣ | 0..1 | Resource | Each MedCom message shall contain a MedComMessagingMessageHeader and MedComMessagingProvenance. Please refer to invariant medcom-messaging-1, medcom-messaging-2, and medcom-messaging-3. | ||||
| search |
ΣC | 0..1 | BackboneElement | Search related information | ||||
| 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 | ||||
| mode |
Σ | 0..1 | code | match | include | outcome - why this is in the result set Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. | ||||
| score |
Σ | 0..1 | decimal | Search ranking (between 0 and 1) | ||||
| request |
ΣC | 0..1 | BackboneElement | Additional execution information (transaction/batch/history) | ||||
| 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 | ||||
| method |
Σ | 1..1 | code | GET | HEAD | POST | PUT | DELETE | PATCH Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details. | ||||
| url |
Σ | 1..1 | uri | URL for HTTP equivalent of this entry | ||||
| ifNoneMatch |
Σ | 0..1 | string | For managing cache currency | ||||
| ifModifiedSince |
Σ | 0..1 | instant | For managing cache currency | ||||
| ifMatch |
Σ | 0..1 | string | For managing update contention | ||||
| ifNoneExist |
Σ | 0..1 | string | For conditional creates | ||||
| response |
ΣC | 0..1 | BackboneElement | Results of execution (transaction/batch/history) | ||||
| 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 | ||||
| status |
Σ | 1..1 | string | Status response code (text optional) | ||||
| location |
Σ | 0..1 | uri | The location (if the operation returns a location) | ||||
| etag |
Σ | 0..1 | string | The Etag for the resource (if relevant) | ||||
| lastModified |
Σ | 0..1 | instant | Server's date time modified | ||||
| outcome |
Σ | 0..1 | Resource | OperationOutcome with hints and warnings (for batch/transaction) | ||||
| signature |
Σ | 0..1 | Signature | Digital Signature | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| Bundle.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| Bundle.type | required | Pattern: messagehttp://hl7.org/fhir/ValueSet/bundle-type|4.0.1from the FHIR Standard | ||||
| Bundle.entry.search.mode | required | SearchEntryModehttp://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1from the FHIR Standard | ||||
| Bundle.entry.request.method | required | HTTPVerbhttp://hl7.org/fhir/ValueSet/http-verb|4.0.1from the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| bdl-1 | error | Bundle | total only when a search or history : total.empty() or (type = 'searchset') or (type = 'history') | |
| bdl-2 | error | Bundle | entry.search only when a search : entry.search.empty() or (type = 'searchset') | |
| bdl-3 | error | Bundle | entry.request mandatory for batch/transaction/history, otherwise prohibited : entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history')) | |
| bdl-4 | error | Bundle | entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited : entry.all(response.exists() = (%resource.type = 'batch-response' or %resource.type = 'transaction-response' or %resource.type = 'history')) | |
| bdl-5 | error | Bundle.entry | must be a resource unless there's a request or response : resource.exists() or request.exists() or response.exists() | |
| bdl-7 | error | Bundle | FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles) : (type = 'history') or entry.where(fullUrl.exists()).select(fullUrl&resource.meta.versionId).isDistinct() | |
| bdl-8 | error | Bundle.entry | fullUrl cannot be a version specific reference : fullUrl.contains('/_history/').not() | |
| bdl-9 | error | Bundle | A document must have an identifier with a system and a value : type = 'document' implies (identifier.system.exists() and identifier.value.exists()) | |
| bdl-10 | error | Bundle | A document must have a date : type = 'document' implies (timestamp.hasValue()) | |
| bdl-11 | error | Bundle | A document must have a Composition as the first resource : type = 'document' implies entry.first().resource.is(Composition) | |
| bdl-12 | error | Bundle | A message must have a MessageHeader as the first resource : type = 'message' implies entry.first().resource.is(MessageHeader) | |
| 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-hospitalNotification-1 | error | Bundle | The message header shall conform to medcom-hospitalNotification-messageHeader profile : entry.ofType(MessageHeader).all(resource.conformsTo('http://medcomfhir.dk/fhir/hospitalnotification/StructureDefinition/medcom-hospitalNotification-messageHeader')) | |
| medcom-hospitalNotification-2 | error | Bundle | Entry shall contain exactly one patient resource : entry.where(resource.is(Patient)).count() = 1 | |
| medcom-hospitalNotification-3 | error | Bundle | All provenance resources shall contain activities from medcom-hospitalNotification-messageActivities valueset : entry.ofType(Provenance).all(resource.activity.memberOf('http://medcomfhir.dk/fhir/dk-medcom-terminology/ValueSet/medcom-hospitalNotification-messageActivities')) | |
| medcom-hospitalNotification-4 | error | Bundle | The system of Patient.identifier shall be 'urn:oid:1.2.208.176.1.2', which represents an official Danish CPR-number : entry.resource.ofType(Patient).identifier.system = 'urn:oid:1.2.208.176.1.2' | |
| medcom-hospitalNotification-5 | error | Bundle | The receiver of a HospitalNotification shall always be a primary receiver. : Bundle.entry.resource.ofType(MessageHeader).destination.extension.value.code = 'primary' | |
| medcom-messaging-1 | error | Bundle | The MessageHeader resource shall conform to medcom-messaging-messageHeader profile : entry[0].resource.conformsTo('http://medcomfhir.dk/ig/messaging/StructureDefinition/medcom-messaging-messageHeader') | |
| medcom-messaging-2 | error | Bundle | There shall be at least one Provenance resource in a MedCom message : entry.resource.ofType(Provenance).exists() |
This structure is derived from MedComMessagingMessage
Differential View
This structure is derived from MedComMessagingMessage
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Bundle |
C | 0..* | MedComMessagingMessage | Contains a collection of resources medcom-hospitalNotification-1: The message header shall conform to medcom-hospitalNotification-messageHeader profile medcom-hospitalNotification-2: Entry shall contain exactly one patient resource medcom-hospitalNotification-3: All provenance resources shall contain activities from medcom-hospitalNotification-messageActivities valueset medcom-hospitalNotification-4: The system of Patient.identifier shall be 'urn:oid:1.2.208.176.1.2', which represents an official Danish CPR-number medcom-hospitalNotification-5: The receiver of a HospitalNotification shall always be a primary receiver. |
| id |
1..1 | id | A unique identifier for a bundle. The element must be updated with a new value each time a new message is sent. | |
| timestamp |
1..1 | instant | Holds information about when a bundle is created. | |
| entry |
0..* | BackboneElement | Message content (MedComHospitalNotificationMessageHeader, MedComMessagingOrganization, MedComMessagingProvenance, MedComHospitalNotificationEncounter, MedComCorePatient) - Open | |
| Documentation for this format | ||||
| Id | Grade | Path(s) | Details | Requirements |
| medcom-hospitalNotification-1 | error | Bundle | The message header shall conform to medcom-hospitalNotification-messageHeader profile : entry.ofType(MessageHeader).all(resource.conformsTo('http://medcomfhir.dk/fhir/hospitalnotification/StructureDefinition/medcom-hospitalNotification-messageHeader')) | |
| medcom-hospitalNotification-2 | error | Bundle | Entry shall contain exactly one patient resource : entry.where(resource.is(Patient)).count() = 1 | |
| medcom-hospitalNotification-3 | error | Bundle | All provenance resources shall contain activities from medcom-hospitalNotification-messageActivities valueset : entry.ofType(Provenance).all(resource.activity.memberOf('http://medcomfhir.dk/fhir/dk-medcom-terminology/ValueSet/medcom-hospitalNotification-messageActivities')) | |
| medcom-hospitalNotification-4 | error | Bundle | The system of Patient.identifier shall be 'urn:oid:1.2.208.176.1.2', which represents an official Danish CPR-number : entry.resource.ofType(Patient).identifier.system = 'urn:oid:1.2.208.176.1.2' | |
| medcom-hospitalNotification-5 | error | Bundle | The receiver of a HospitalNotification shall always be a primary receiver. : Bundle.entry.resource.ofType(MessageHeader).destination.extension.value.code = 'primary' |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Bundle |
C | 0..* | MedComMessagingMessage | Contains a collection of resources bdl-1: total only when a search or history bdl-2: entry.search only when a search bdl-3: entry.request mandatory for batch/transaction/history, otherwise prohibited bdl-4: entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited bdl-7: FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles) bdl-9: A document must have an identifier with a system and a value bdl-10: A document must have a date bdl-11: A document must have a Composition as the first resource bdl-12: A message must have a MessageHeader as the first resource medcom-messaging-1: The MessageHeader resource shall conform to medcom-messaging-messageHeader profile medcom-messaging-2: There shall be at least one Provenance resource in a MedCom message medcom-hospitalNotification-1: The message header shall conform to medcom-hospitalNotification-messageHeader profile medcom-hospitalNotification-2: Entry shall contain exactly one patient resource medcom-hospitalNotification-3: All provenance resources shall contain activities from medcom-hospitalNotification-messageActivities valueset medcom-hospitalNotification-4: The system of Patient.identifier shall be 'urn:oid:1.2.208.176.1.2', which represents an official Danish CPR-number medcom-hospitalNotification-5: The receiver of a HospitalNotification shall always be a primary receiver. |
| id |
SΣ | 1..1 | id | A unique identifier for a bundle. The element must be updated with a new value each time a new message is sent. |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
| type |
SΣ | 1..1 | code | Always message Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used. Required Pattern: message |
| timestamp |
SΣ | 1..1 | instant | Holds information about when a bundle is created. |
| entry |
SΣC | 0..* | BackboneElement | Message content (MedComHospitalNotificationMessageHeader, MedComMessagingOrganization, MedComMessagingProvenance, MedComHospitalNotificationEncounter, MedComCorePatient) - Open bdl-5: must be a resource unless there's a request or response bdl-8: fullUrl cannot be a version specific reference This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| resource |
SΣ | 0..1 | Resource | Each MedCom message shall contain a MedComMessagingMessageHeader and MedComMessagingProvenance. Please refer to invariant medcom-messaging-1, medcom-messaging-2, and medcom-messaging-3. |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Bundle.type | required | Pattern: messagehttp://hl7.org/fhir/ValueSet/bundle-type|4.0.1from the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| bdl-1 | error | Bundle | total only when a search or history : total.empty() or (type = 'searchset') or (type = 'history') | |
| bdl-2 | error | Bundle | entry.search only when a search : entry.search.empty() or (type = 'searchset') | |
| bdl-3 | error | Bundle | entry.request mandatory for batch/transaction/history, otherwise prohibited : entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history')) | |
| bdl-4 | error | Bundle | entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited : entry.all(response.exists() = (%resource.type = 'batch-response' or %resource.type = 'transaction-response' or %resource.type = 'history')) | |
| bdl-5 | error | Bundle.entry | must be a resource unless there's a request or response : resource.exists() or request.exists() or response.exists() | |
| bdl-7 | error | Bundle | FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles) : (type = 'history') or entry.where(fullUrl.exists()).select(fullUrl&resource.meta.versionId).isDistinct() | |
| bdl-8 | error | Bundle.entry | fullUrl cannot be a version specific reference : fullUrl.contains('/_history/').not() | |
| bdl-9 | error | Bundle | A document must have an identifier with a system and a value : type = 'document' implies (identifier.system.exists() and identifier.value.exists()) | |
| bdl-10 | error | Bundle | A document must have a date : type = 'document' implies (timestamp.hasValue()) | |
| bdl-11 | error | Bundle | A document must have a Composition as the first resource : type = 'document' implies entry.first().resource.is(Composition) | |
| bdl-12 | error | Bundle | A message must have a MessageHeader as the first resource : type = 'message' implies entry.first().resource.is(MessageHeader) | |
| 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-hospitalNotification-1 | error | Bundle | The message header shall conform to medcom-hospitalNotification-messageHeader profile : entry.ofType(MessageHeader).all(resource.conformsTo('http://medcomfhir.dk/fhir/hospitalnotification/StructureDefinition/medcom-hospitalNotification-messageHeader')) | |
| medcom-hospitalNotification-2 | error | Bundle | Entry shall contain exactly one patient resource : entry.where(resource.is(Patient)).count() = 1 | |
| medcom-hospitalNotification-3 | error | Bundle | All provenance resources shall contain activities from medcom-hospitalNotification-messageActivities valueset : entry.ofType(Provenance).all(resource.activity.memberOf('http://medcomfhir.dk/fhir/dk-medcom-terminology/ValueSet/medcom-hospitalNotification-messageActivities')) | |
| medcom-hospitalNotification-4 | error | Bundle | The system of Patient.identifier shall be 'urn:oid:1.2.208.176.1.2', which represents an official Danish CPR-number : entry.resource.ofType(Patient).identifier.system = 'urn:oid:1.2.208.176.1.2' | |
| medcom-hospitalNotification-5 | error | Bundle | The receiver of a HospitalNotification shall always be a primary receiver. : Bundle.entry.resource.ofType(MessageHeader).destination.extension.value.code = 'primary' | |
| medcom-messaging-1 | error | Bundle | The MessageHeader resource shall conform to medcom-messaging-messageHeader profile : entry[0].resource.conformsTo('http://medcomfhir.dk/ig/messaging/StructureDefinition/medcom-messaging-messageHeader') | |
| medcom-messaging-2 | error | Bundle | There shall be at least one Provenance resource in a MedCom message : entry.resource.ofType(Provenance).exists() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Bundle |
C | 0..* | MedComMessagingMessage | Contains a collection of resources bdl-1: total only when a search or history bdl-2: entry.search only when a search bdl-3: entry.request mandatory for batch/transaction/history, otherwise prohibited bdl-4: entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited bdl-7: FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles) bdl-9: A document must have an identifier with a system and a value bdl-10: A document must have a date bdl-11: A document must have a Composition as the first resource bdl-12: A message must have a MessageHeader as the first resource medcom-messaging-1: The MessageHeader resource shall conform to medcom-messaging-messageHeader profile medcom-messaging-2: There shall be at least one Provenance resource in a MedCom message medcom-hospitalNotification-1: The message header shall conform to medcom-hospitalNotification-messageHeader profile medcom-hospitalNotification-2: Entry shall contain exactly one patient resource medcom-hospitalNotification-3: All provenance resources shall contain activities from medcom-hospitalNotification-messageActivities valueset medcom-hospitalNotification-4: The system of Patient.identifier shall be 'urn:oid:1.2.208.176.1.2', which represents an official Danish CPR-number medcom-hospitalNotification-5: The receiver of a HospitalNotification shall always be a primary receiver. | ||||
| id |
SΣ | 1..1 | id | A unique identifier for a bundle. The element must be updated with a new value each time a new message is sent. | ||||
| 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.
| |||||
| identifier |
Σ | 0..1 | Identifier | Persistent identifier for the bundle | ||||
| type |
SΣ | 1..1 | code | Always message Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used. Required Pattern: message | ||||
| timestamp |
SΣ | 1..1 | instant | Holds information about when a bundle is created. | ||||
| total |
ΣC | 0..1 | unsignedInt | If search, the total number of matches | ||||
| link |
Σ | 0..* | BackboneElement | Links related to this Bundle | ||||
| 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 | ||||
| relation |
Σ | 1..1 | string | See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1 | ||||
| url |
Σ | 1..1 | uri | Reference details for the link | ||||
| entry |
SΣC | 0..* | BackboneElement | Message content (MedComHospitalNotificationMessageHeader, MedComMessagingOrganization, MedComMessagingProvenance, MedComHospitalNotificationEncounter, MedComCorePatient) - Open bdl-5: must be a resource unless there's a request or response bdl-8: fullUrl cannot be a version specific reference This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type | ||||
| 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 | ||||
| link |
Σ | 0..* | See link (Bundle) | Links related to this entry | ||||
| fullUrl |
Σ | 0..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||
| resource |
SΣ | 0..1 | Resource | Each MedCom message shall contain a MedComMessagingMessageHeader and MedComMessagingProvenance. Please refer to invariant medcom-messaging-1, medcom-messaging-2, and medcom-messaging-3. | ||||
| search |
ΣC | 0..1 | BackboneElement | Search related information | ||||
| 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 | ||||
| mode |
Σ | 0..1 | code | match | include | outcome - why this is in the result set Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. | ||||
| score |
Σ | 0..1 | decimal | Search ranking (between 0 and 1) | ||||
| request |
ΣC | 0..1 | BackboneElement | Additional execution information (transaction/batch/history) | ||||
| 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 | ||||
| method |
Σ | 1..1 | code | GET | HEAD | POST | PUT | DELETE | PATCH Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details. | ||||
| url |
Σ | 1..1 | uri | URL for HTTP equivalent of this entry | ||||
| ifNoneMatch |
Σ | 0..1 | string | For managing cache currency | ||||
| ifModifiedSince |
Σ | 0..1 | instant | For managing cache currency | ||||
| ifMatch |
Σ | 0..1 | string | For managing update contention | ||||
| ifNoneExist |
Σ | 0..1 | string | For conditional creates | ||||
| response |
ΣC | 0..1 | BackboneElement | Results of execution (transaction/batch/history) | ||||
| 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 | ||||
| status |
Σ | 1..1 | string | Status response code (text optional) | ||||
| location |
Σ | 0..1 | uri | The location (if the operation returns a location) | ||||
| etag |
Σ | 0..1 | string | The Etag for the resource (if relevant) | ||||
| lastModified |
Σ | 0..1 | instant | Server's date time modified | ||||
| outcome |
Σ | 0..1 | Resource | OperationOutcome with hints and warnings (for batch/transaction) | ||||
| signature |
Σ | 0..1 | Signature | Digital Signature | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| Bundle.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| Bundle.type | required | Pattern: messagehttp://hl7.org/fhir/ValueSet/bundle-type|4.0.1from the FHIR Standard | ||||
| Bundle.entry.search.mode | required | SearchEntryModehttp://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1from the FHIR Standard | ||||
| Bundle.entry.request.method | required | HTTPVerbhttp://hl7.org/fhir/ValueSet/http-verb|4.0.1from the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| bdl-1 | error | Bundle | total only when a search or history : total.empty() or (type = 'searchset') or (type = 'history') | |
| bdl-2 | error | Bundle | entry.search only when a search : entry.search.empty() or (type = 'searchset') | |
| bdl-3 | error | Bundle | entry.request mandatory for batch/transaction/history, otherwise prohibited : entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history')) | |
| bdl-4 | error | Bundle | entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited : entry.all(response.exists() = (%resource.type = 'batch-response' or %resource.type = 'transaction-response' or %resource.type = 'history')) | |
| bdl-5 | error | Bundle.entry | must be a resource unless there's a request or response : resource.exists() or request.exists() or response.exists() | |
| bdl-7 | error | Bundle | FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles) : (type = 'history') or entry.where(fullUrl.exists()).select(fullUrl&resource.meta.versionId).isDistinct() | |
| bdl-8 | error | Bundle.entry | fullUrl cannot be a version specific reference : fullUrl.contains('/_history/').not() | |
| bdl-9 | error | Bundle | A document must have an identifier with a system and a value : type = 'document' implies (identifier.system.exists() and identifier.value.exists()) | |
| bdl-10 | error | Bundle | A document must have a date : type = 'document' implies (timestamp.hasValue()) | |
| bdl-11 | error | Bundle | A document must have a Composition as the first resource : type = 'document' implies entry.first().resource.is(Composition) | |
| bdl-12 | error | Bundle | A message must have a MessageHeader as the first resource : type = 'message' implies entry.first().resource.is(MessageHeader) | |
| 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-hospitalNotification-1 | error | Bundle | The message header shall conform to medcom-hospitalNotification-messageHeader profile : entry.ofType(MessageHeader).all(resource.conformsTo('http://medcomfhir.dk/fhir/hospitalnotification/StructureDefinition/medcom-hospitalNotification-messageHeader')) | |
| medcom-hospitalNotification-2 | error | Bundle | Entry shall contain exactly one patient resource : entry.where(resource.is(Patient)).count() = 1 | |
| medcom-hospitalNotification-3 | error | Bundle | All provenance resources shall contain activities from medcom-hospitalNotification-messageActivities valueset : entry.ofType(Provenance).all(resource.activity.memberOf('http://medcomfhir.dk/fhir/dk-medcom-terminology/ValueSet/medcom-hospitalNotification-messageActivities')) | |
| medcom-hospitalNotification-4 | error | Bundle | The system of Patient.identifier shall be 'urn:oid:1.2.208.176.1.2', which represents an official Danish CPR-number : entry.resource.ofType(Patient).identifier.system = 'urn:oid:1.2.208.176.1.2' | |
| medcom-hospitalNotification-5 | error | Bundle | The receiver of a HospitalNotification shall always be a primary receiver. : Bundle.entry.resource.ofType(MessageHeader).destination.extension.value.code = 'primary' | |
| medcom-messaging-1 | error | Bundle | The MessageHeader resource shall conform to medcom-messaging-messageHeader profile : entry[0].resource.conformsTo('http://medcomfhir.dk/ig/messaging/StructureDefinition/medcom-messaging-messageHeader') | |
| medcom-messaging-2 | error | Bundle | There shall be at least one Provenance resource in a MedCom message : entry.resource.ofType(Provenance).exists() |
This structure is derived from MedComMessagingMessage
Other representations of profile: CSV, Excel, Schematron