DK MedCom Carecommunication
5.0.1 - release
DK MedCom Carecommunication
5.0.1 - release
DK MedCom Carecommunication, published by MedCom. This guide is not an authorized publication; it is the continuous build for version 5.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-carecommunication/ and changes regularly. See the Directory of published versions
| Official URL: http://medcomfhir.dk/ig/carecommunication/StructureDefinition/medcom-careCommunication-message | Version: 5.0.1 | |||
| Active as of 2025-11-18 | Computable Name: MedComCareCommunicationMessage | |||
The CareCommunication is used to ensure secure electronic communication of personally identifiable information and is most often used for ad hoc communication between parties in Danish Healthcare. However, the CareCommunication shall only be used in areas where no other MedCom standard is available, and it must not be used for cases with an acute nature.
This profile is the root profile of MedCom FHIR CareCommunication message. This profile is inherited from the MedComMessagingMessage. The following figure represent the profiles that should be included in a MedCom FHIR CareCommunication message.
The Bundle containing the CareCommunication message is selfcontained, why it shall contain one instance of the MedComCareCommunicationMessageHeader. 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 MedComCareCommunicationMessage.
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:   |
|---|---|---|---|---|
  Bundle |
C | 0..* | MedComMessagingMessage | Contains a collection of resources Constraints: bdl-1, bdl-2, bdl-3, bdl-4, bdl-7, bdl-9, bdl-10, bdl-11, bdl-12, medcom-messaging-1, medcom-messaging-2, medcom-careCommunication-1, medcom-careCommunication-2, medcom-careCommunication-4, medcom-careCommunication-3, medcom-careCommunication-12, medcom-careCommunication-11, medcom-careCommunication-13 |
  id |
SΣ | 1..1 | id | Logical id of this artifact |
| 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 | When the bundle was assembled |
  entry |
SΣC | 0..* | BackboneElement | Message content (MedComCareCommunicationMessageHeader, MedComMessagingOrganization, MedComMessagingProvenance, MedComCareCommunication, MedComCorePatient, MedComCoreEncounter, MedComCorePractitioner, MedComCorePractitionerRole, MedComCoreCareTeam) - Open Constraints: bdl-5, bdl-8 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Σ | 1..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 | Status | Usage | ValueSet | Version | Source |
| Bundle.type | Base | required | BundleType | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| 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-careCommunication-1 | error | Bundle | The MessageHeader shall conform to medcom-careCommunication-messageHeader profile |
entry[0].resource.conformsTo('http://medcomfhir.dk/ig/carecommunication/StructureDefinition/medcom-careCommunication-messageHeader')
|
| medcom-careCommunication-2 | error | Bundle | Entry shall contain exactly one Patient resource |
entry.where(resource.is(Patient)).count() = 1
|
| medcom-careCommunication-3 | error | Bundle | All Provenance resources shall be of the type medcom-careCommunication-provenance profile |
entry.resource.ofType(Provenance).all(conformsTo('http://medcomfhir.dk/ig/carecommunication/StructureDefinition/medcom-careCommunication-provenance'))
|
| medcom-careCommunication-4 | error | Bundle | There shall exist a practitioner given and family name when using a PractitionerRole. |
entry.resource.ofType(Practitioner).name.exists()
|
| medcom-careCommunication-11 | error | Bundle | If a specific sender is present, at least one of the organisations that the referenced CareTeam or Practitioner/PractitionerRole belongs to MUST equal the organisation referenced in MessageHeader.sender. If no specific sender extension is present, this rule is not evaluated. |
Bundle.entry.resource.ofType(Communication).extension.value.reference.resolve().managingOrganization.reference.resolve()
= %resource.entry.resource.ofType(MessageHeader).sender.reference.resolve()
or Bundle.entry.resource.ofType(Communication).extension.value.reference.resolve().organization.reference.resolve()
= %resource.entry.resource.ofType(MessageHeader).sender.reference.resolve()
or Bundle.entry.resource.ofType(Communication).extension.exists().not()
|
| medcom-careCommunication-12 | error | Bundle | If a specific recipient is present, at least one of the organisations that the referenced CareTeam or Practitioner/PractitionerRole belongs to MUST equal the organisation referenced in MessageHeader.receiver. If no specific recipient is present, this rule is not evaluated. |
Bundle.entry.resource.ofType(Communication).recipient.reference.resolve().managingOrganization.reference.resolve() = %resource.entry.resource.ofType(MessageHeader).destination.receiver.reference.resolve() or Bundle.entry.resource.ofType(Communication).recipient.reference.resolve().organization.reference.resolve() = %resource.entry.resource.ofType(MessageHeader).destination.receiver.reference.resolve() or Bundle.entry.resource.ofType(Communication).recipient.exists().not()
|
| medcom-careCommunication-13 | error | Bundle | All PractitionerRole resources shall have a reference to an instance of a Practitioner resource. |
Bundle.entry.resource.ofType(PractitionerRole).practitioner.reference.exists()
|
| 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
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Bundle |
C | 0..* | MedComMessagingMessage | Contains a collection of resources Constraints: medcom-careCommunication-1, medcom-careCommunication-2, medcom-careCommunication-4, medcom-careCommunication-3, medcom-careCommunication-12, medcom-careCommunication-11, medcom-careCommunication-13 |
 entry |
0..* | BackboneElement | Message content (MedComCareCommunicationMessageHeader, MedComMessagingOrganization, MedComMessagingProvenance, MedComCareCommunication, MedComCorePatient, MedComCoreEncounter, MedComCorePractitioner, MedComCorePractitionerRole, MedComCoreCareTeam) - Open | |
| resource |
1..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 | ||||
| Id | Grade | Path(s) | Description | Expression |
| medcom-careCommunication-1 | error | Bundle | The MessageHeader shall conform to medcom-careCommunication-messageHeader profile |
entry[0].resource.conformsTo('http://medcomfhir.dk/ig/carecommunication/StructureDefinition/medcom-careCommunication-messageHeader')
|
| medcom-careCommunication-2 | error | Bundle | Entry shall contain exactly one Patient resource |
entry.where(resource.is(Patient)).count() = 1
|
| medcom-careCommunication-3 | error | Bundle | All Provenance resources shall be of the type medcom-careCommunication-provenance profile |
entry.resource.ofType(Provenance).all(conformsTo('http://medcomfhir.dk/ig/carecommunication/StructureDefinition/medcom-careCommunication-provenance'))
|
| medcom-careCommunication-4 | error | Bundle | There shall exist a practitioner given and family name when using a PractitionerRole. |
entry.resource.ofType(Practitioner).name.exists()
|
| medcom-careCommunication-11 | error | Bundle | If a specific sender is present, at least one of the organisations that the referenced CareTeam or Practitioner/PractitionerRole belongs to MUST equal the organisation referenced in MessageHeader.sender. If no specific sender extension is present, this rule is not evaluated. |
Bundle.entry.resource.ofType(Communication).extension.value.reference.resolve().managingOrganization.reference.resolve()
= %resource.entry.resource.ofType(MessageHeader).sender.reference.resolve()
or Bundle.entry.resource.ofType(Communication).extension.value.reference.resolve().organization.reference.resolve()
= %resource.entry.resource.ofType(MessageHeader).sender.reference.resolve()
or Bundle.entry.resource.ofType(Communication).extension.exists().not()
|
| medcom-careCommunication-12 | error | Bundle | If a specific recipient is present, at least one of the organisations that the referenced CareTeam or Practitioner/PractitionerRole belongs to MUST equal the organisation referenced in MessageHeader.receiver. If no specific recipient is present, this rule is not evaluated. |
Bundle.entry.resource.ofType(Communication).recipient.reference.resolve().managingOrganization.reference.resolve() = %resource.entry.resource.ofType(MessageHeader).destination.receiver.reference.resolve() or Bundle.entry.resource.ofType(Communication).recipient.reference.resolve().organization.reference.resolve() = %resource.entry.resource.ofType(MessageHeader).destination.receiver.reference.resolve() or Bundle.entry.resource.ofType(Communication).recipient.exists().not()
|
| medcom-careCommunication-13 | error | Bundle | All PractitionerRole resources shall have a reference to an instance of a Practitioner resource. |
Bundle.entry.resource.ofType(PractitionerRole).practitioner.reference.exists()
|
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Bundle |
C | 0..* | MedComMessagingMessage | Contains a collection of resources Constraints: bdl-1, bdl-2, bdl-3, bdl-4, bdl-7, bdl-9, bdl-10, bdl-11, bdl-12, medcom-messaging-1, medcom-messaging-2, medcom-careCommunication-1, medcom-careCommunication-2, medcom-careCommunication-4, medcom-careCommunication-3, medcom-careCommunication-12, medcom-careCommunication-11, medcom-careCommunication-13 | ||||
| id |
SΣ | 1..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| 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 | When the bundle was assembled | ||||
| 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 (MedComCareCommunicationMessageHeader, MedComMessagingOrganization, MedComMessagingProvenance, MedComCareCommunication, MedComCorePatient, MedComCoreEncounter, MedComCorePractitioner, MedComCorePractitionerRole, MedComCoreCareTeam) - Open Constraints: bdl-5, bdl-8 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Σ | 1..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 | Status | Usage | ValueSet | Version | Source |
| Bundle.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Bundle.type | Base | required | BundleType | 📍4.0.1 | FHIR Std. |
| Bundle.entry.search.mode | Base | required | SearchEntryMode | 📍4.0.1 | FHIR Std. |
| Bundle.entry.request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| 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-careCommunication-1 | error | Bundle | The MessageHeader shall conform to medcom-careCommunication-messageHeader profile |
entry[0].resource.conformsTo('http://medcomfhir.dk/ig/carecommunication/StructureDefinition/medcom-careCommunication-messageHeader')
|
| medcom-careCommunication-2 | error | Bundle | Entry shall contain exactly one Patient resource |
entry.where(resource.is(Patient)).count() = 1
|
| medcom-careCommunication-3 | error | Bundle | All Provenance resources shall be of the type medcom-careCommunication-provenance profile |
entry.resource.ofType(Provenance).all(conformsTo('http://medcomfhir.dk/ig/carecommunication/StructureDefinition/medcom-careCommunication-provenance'))
|
| medcom-careCommunication-4 | error | Bundle | There shall exist a practitioner given and family name when using a PractitionerRole. |
entry.resource.ofType(Practitioner).name.exists()
|
| medcom-careCommunication-11 | error | Bundle | If a specific sender is present, at least one of the organisations that the referenced CareTeam or Practitioner/PractitionerRole belongs to MUST equal the organisation referenced in MessageHeader.sender. If no specific sender extension is present, this rule is not evaluated. |
Bundle.entry.resource.ofType(Communication).extension.value.reference.resolve().managingOrganization.reference.resolve()
= %resource.entry.resource.ofType(MessageHeader).sender.reference.resolve()
or Bundle.entry.resource.ofType(Communication).extension.value.reference.resolve().organization.reference.resolve()
= %resource.entry.resource.ofType(MessageHeader).sender.reference.resolve()
or Bundle.entry.resource.ofType(Communication).extension.exists().not()
|
| medcom-careCommunication-12 | error | Bundle | If a specific recipient is present, at least one of the organisations that the referenced CareTeam or Practitioner/PractitionerRole belongs to MUST equal the organisation referenced in MessageHeader.receiver. If no specific recipient is present, this rule is not evaluated. |
Bundle.entry.resource.ofType(Communication).recipient.reference.resolve().managingOrganization.reference.resolve() = %resource.entry.resource.ofType(MessageHeader).destination.receiver.reference.resolve() or Bundle.entry.resource.ofType(Communication).recipient.reference.resolve().organization.reference.resolve() = %resource.entry.resource.ofType(MessageHeader).destination.receiver.reference.resolve() or Bundle.entry.resource.ofType(Communication).recipient.exists().not()
|
| medcom-careCommunication-13 | error | Bundle | All PractitionerRole resources shall have a reference to an instance of a Practitioner resource. |
Bundle.entry.resource.ofType(PractitionerRole).practitioner.reference.exists()
|
| 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
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Bundle |
C | 0..* | MedComMessagingMessage | Contains a collection of resources Constraints: bdl-1, bdl-2, bdl-3, bdl-4, bdl-7, bdl-9, bdl-10, bdl-11, bdl-12, medcom-messaging-1, medcom-messaging-2, medcom-careCommunication-1, medcom-careCommunication-2, medcom-careCommunication-4, medcom-careCommunication-3, medcom-careCommunication-12, medcom-careCommunication-11, medcom-careCommunication-13 |
| id |
SΣ | 1..1 | id | Logical id of this artifact |
| 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 | When the bundle was assembled |
| entry |
SΣC | 0..* | BackboneElement | Message content (MedComCareCommunicationMessageHeader, MedComMessagingOrganization, MedComMessagingProvenance, MedComCareCommunication, MedComCorePatient, MedComCoreEncounter, MedComCorePractitioner, MedComCorePractitionerRole, MedComCoreCareTeam) - Open Constraints: bdl-5, bdl-8 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Σ | 1..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 | Status | Usage | ValueSet | Version | Source |
| Bundle.type | Base | required | BundleType | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| 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-careCommunication-1 | error | Bundle | The MessageHeader shall conform to medcom-careCommunication-messageHeader profile |
entry[0].resource.conformsTo('http://medcomfhir.dk/ig/carecommunication/StructureDefinition/medcom-careCommunication-messageHeader')
|
| medcom-careCommunication-2 | error | Bundle | Entry shall contain exactly one Patient resource |
entry.where(resource.is(Patient)).count() = 1
|
| medcom-careCommunication-3 | error | Bundle | All Provenance resources shall be of the type medcom-careCommunication-provenance profile |
entry.resource.ofType(Provenance).all(conformsTo('http://medcomfhir.dk/ig/carecommunication/StructureDefinition/medcom-careCommunication-provenance'))
|
| medcom-careCommunication-4 | error | Bundle | There shall exist a practitioner given and family name when using a PractitionerRole. |
entry.resource.ofType(Practitioner).name.exists()
|
| medcom-careCommunication-11 | error | Bundle | If a specific sender is present, at least one of the organisations that the referenced CareTeam or Practitioner/PractitionerRole belongs to MUST equal the organisation referenced in MessageHeader.sender. If no specific sender extension is present, this rule is not evaluated. |
Bundle.entry.resource.ofType(Communication).extension.value.reference.resolve().managingOrganization.reference.resolve()
= %resource.entry.resource.ofType(MessageHeader).sender.reference.resolve()
or Bundle.entry.resource.ofType(Communication).extension.value.reference.resolve().organization.reference.resolve()
= %resource.entry.resource.ofType(MessageHeader).sender.reference.resolve()
or Bundle.entry.resource.ofType(Communication).extension.exists().not()
|
| medcom-careCommunication-12 | error | Bundle | If a specific recipient is present, at least one of the organisations that the referenced CareTeam or Practitioner/PractitionerRole belongs to MUST equal the organisation referenced in MessageHeader.receiver. If no specific recipient is present, this rule is not evaluated. |
Bundle.entry.resource.ofType(Communication).recipient.reference.resolve().managingOrganization.reference.resolve() = %resource.entry.resource.ofType(MessageHeader).destination.receiver.reference.resolve() or Bundle.entry.resource.ofType(Communication).recipient.reference.resolve().organization.reference.resolve() = %resource.entry.resource.ofType(MessageHeader).destination.receiver.reference.resolve() or Bundle.entry.resource.ofType(Communication).recipient.exists().not()
|
| medcom-careCommunication-13 | error | Bundle | All PractitionerRole resources shall have a reference to an instance of a Practitioner resource. |
Bundle.entry.resource.ofType(PractitionerRole).practitioner.reference.exists()
|
| 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()
|
Differential View
This structure is derived from MedComMessagingMessage
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Bundle |
C | 0..* | MedComMessagingMessage | Contains a collection of resources Constraints: medcom-careCommunication-1, medcom-careCommunication-2, medcom-careCommunication-4, medcom-careCommunication-3, medcom-careCommunication-12, medcom-careCommunication-11, medcom-careCommunication-13 |
| entry |
0..* | BackboneElement | Message content (MedComCareCommunicationMessageHeader, MedComMessagingOrganization, MedComMessagingProvenance, MedComCareCommunication, MedComCorePatient, MedComCoreEncounter, MedComCorePractitioner, MedComCorePractitionerRole, MedComCoreCareTeam) - Open | |
| resource |
1..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 | ||||
| Id | Grade | Path(s) | Description | Expression |
| medcom-careCommunication-1 | error | Bundle | The MessageHeader shall conform to medcom-careCommunication-messageHeader profile |
entry[0].resource.conformsTo('http://medcomfhir.dk/ig/carecommunication/StructureDefinition/medcom-careCommunication-messageHeader')
|
| medcom-careCommunication-2 | error | Bundle | Entry shall contain exactly one Patient resource |
entry.where(resource.is(Patient)).count() = 1
|
| medcom-careCommunication-3 | error | Bundle | All Provenance resources shall be of the type medcom-careCommunication-provenance profile |
entry.resource.ofType(Provenance).all(conformsTo('http://medcomfhir.dk/ig/carecommunication/StructureDefinition/medcom-careCommunication-provenance'))
|
| medcom-careCommunication-4 | error | Bundle | There shall exist a practitioner given and family name when using a PractitionerRole. |
entry.resource.ofType(Practitioner).name.exists()
|
| medcom-careCommunication-11 | error | Bundle | If a specific sender is present, at least one of the organisations that the referenced CareTeam or Practitioner/PractitionerRole belongs to MUST equal the organisation referenced in MessageHeader.sender. If no specific sender extension is present, this rule is not evaluated. |
Bundle.entry.resource.ofType(Communication).extension.value.reference.resolve().managingOrganization.reference.resolve()
= %resource.entry.resource.ofType(MessageHeader).sender.reference.resolve()
or Bundle.entry.resource.ofType(Communication).extension.value.reference.resolve().organization.reference.resolve()
= %resource.entry.resource.ofType(MessageHeader).sender.reference.resolve()
or Bundle.entry.resource.ofType(Communication).extension.exists().not()
|
| medcom-careCommunication-12 | error | Bundle | If a specific recipient is present, at least one of the organisations that the referenced CareTeam or Practitioner/PractitionerRole belongs to MUST equal the organisation referenced in MessageHeader.receiver. If no specific recipient is present, this rule is not evaluated. |
Bundle.entry.resource.ofType(Communication).recipient.reference.resolve().managingOrganization.reference.resolve() = %resource.entry.resource.ofType(MessageHeader).destination.receiver.reference.resolve() or Bundle.entry.resource.ofType(Communication).recipient.reference.resolve().organization.reference.resolve() = %resource.entry.resource.ofType(MessageHeader).destination.receiver.reference.resolve() or Bundle.entry.resource.ofType(Communication).recipient.exists().not()
|
| medcom-careCommunication-13 | error | Bundle | All PractitionerRole resources shall have a reference to an instance of a Practitioner resource. |
Bundle.entry.resource.ofType(PractitionerRole).practitioner.reference.exists()
|
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Bundle |
C | 0..* | MedComMessagingMessage | Contains a collection of resources Constraints: bdl-1, bdl-2, bdl-3, bdl-4, bdl-7, bdl-9, bdl-10, bdl-11, bdl-12, medcom-messaging-1, medcom-messaging-2, medcom-careCommunication-1, medcom-careCommunication-2, medcom-careCommunication-4, medcom-careCommunication-3, medcom-careCommunication-12, medcom-careCommunication-11, medcom-careCommunication-13 | ||||
| id |
SΣ | 1..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| 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 | When the bundle was assembled | ||||
| 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 (MedComCareCommunicationMessageHeader, MedComMessagingOrganization, MedComMessagingProvenance, MedComCareCommunication, MedComCorePatient, MedComCoreEncounter, MedComCorePractitioner, MedComCorePractitionerRole, MedComCoreCareTeam) - Open Constraints: bdl-5, bdl-8 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Σ | 1..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 | Status | Usage | ValueSet | Version | Source |
| Bundle.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Bundle.type | Base | required | BundleType | 📍4.0.1 | FHIR Std. |
| Bundle.entry.search.mode | Base | required | SearchEntryMode | 📍4.0.1 | FHIR Std. |
| Bundle.entry.request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| 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-careCommunication-1 | error | Bundle | The MessageHeader shall conform to medcom-careCommunication-messageHeader profile |
entry[0].resource.conformsTo('http://medcomfhir.dk/ig/carecommunication/StructureDefinition/medcom-careCommunication-messageHeader')
|
| medcom-careCommunication-2 | error | Bundle | Entry shall contain exactly one Patient resource |
entry.where(resource.is(Patient)).count() = 1
|
| medcom-careCommunication-3 | error | Bundle | All Provenance resources shall be of the type medcom-careCommunication-provenance profile |
entry.resource.ofType(Provenance).all(conformsTo('http://medcomfhir.dk/ig/carecommunication/StructureDefinition/medcom-careCommunication-provenance'))
|
| medcom-careCommunication-4 | error | Bundle | There shall exist a practitioner given and family name when using a PractitionerRole. |
entry.resource.ofType(Practitioner).name.exists()
|
| medcom-careCommunication-11 | error | Bundle | If a specific sender is present, at least one of the organisations that the referenced CareTeam or Practitioner/PractitionerRole belongs to MUST equal the organisation referenced in MessageHeader.sender. If no specific sender extension is present, this rule is not evaluated. |
Bundle.entry.resource.ofType(Communication).extension.value.reference.resolve().managingOrganization.reference.resolve()
= %resource.entry.resource.ofType(MessageHeader).sender.reference.resolve()
or Bundle.entry.resource.ofType(Communication).extension.value.reference.resolve().organization.reference.resolve()
= %resource.entry.resource.ofType(MessageHeader).sender.reference.resolve()
or Bundle.entry.resource.ofType(Communication).extension.exists().not()
|
| medcom-careCommunication-12 | error | Bundle | If a specific recipient is present, at least one of the organisations that the referenced CareTeam or Practitioner/PractitionerRole belongs to MUST equal the organisation referenced in MessageHeader.receiver. If no specific recipient is present, this rule is not evaluated. |
Bundle.entry.resource.ofType(Communication).recipient.reference.resolve().managingOrganization.reference.resolve() = %resource.entry.resource.ofType(MessageHeader).destination.receiver.reference.resolve() or Bundle.entry.resource.ofType(Communication).recipient.reference.resolve().organization.reference.resolve() = %resource.entry.resource.ofType(MessageHeader).destination.receiver.reference.resolve() or Bundle.entry.resource.ofType(Communication).recipient.exists().not()
|
| medcom-careCommunication-13 | error | Bundle | All PractitionerRole resources shall have a reference to an instance of a Practitioner resource. |
Bundle.entry.resource.ofType(PractitionerRole).practitioner.reference.exists()
|
| 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