DK MedCom acknowledgement
2.0.3 - Release
DK MedCom acknowledgement, published by MedCom. This guide is not an authorized publication; it is the continuous build for version 2.0.3 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/medcomdk/dk-medcom-acknowledgement/ and changes regularly. See the Directory of published versions
Official URL: http://medcomfhir.dk/ig/acknowledgement/StructureDefinition/medcom-messaging-acknowledgement | Version: 2.0.3 | |||
Active as of 2024-09-25 | Computable Name: MedComAcknowledgementMessage |
Base resource for all MedCom Acknowledgement messages.
This profile is the root profile of MedCom Acknowledgement message. Constraint and rules from MedComMessagingMessage are inherited to this profile. The only change is that the MessageHeader shall be a MedComAcknowledgementMessageHeader.
Note: Be aware that entries in a message in general are unordered. Recipients of a message can therefore not assume any particular sequences of elements.
Below can the structure of a MedCom Acknowledgement message be seen.
Please refer to the tab "Snapshot Table(Must support)" below for the definition of the required content of a MedComAcknowledgementMessage.
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-acknowledgement-2: The message header shall conform to medcom-messaging-acknowledgementHeader profile medcom-acknowledgement-1: If the response.code is different than 'ok', a reference to an OperationOutcome resource shall be included. |
entry | 0..* | BackboneElement | Message content (MedComAcknowledgementMessageHeader, MedComMessagingProvenance, MedComMessagingOrganization) - Open | |
Documentation for this format |
Id | Grade | Path(s) | Details | Requirements |
medcom-acknowledgement-1 | error | Bundle | If the response.code is different than 'ok', a reference to an OperationOutcome resource shall be included. : iif(entry.resource.ofType(MessageHeader).response.code = 'ok', true, entry.resource.ofType(MessageHeader).response.code != 'ok' and entry.resource.ofType(OperationOutcome).exists()) | |
medcom-acknowledgement-2 | error | Bundle | The message header shall conform to medcom-messaging-acknowledgementHeader profile : entry.resource.ofType(MessageHeader).conformsTo('http://medcomfhir.dk/ig/acknowledgement/StructureDefinition/medcom-messaging-acknowledgementHeader') |
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-messaging-3: All Provenance resources shall conform to the medcom-messaging-provenance profile medcom-acknowledgement-2: The message header shall conform to medcom-messaging-acknowledgementHeader profile medcom-acknowledgement-1: If the response.code is different than 'ok', a reference to an OperationOutcome resource shall be included. |
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 (MedComAcknowledgementMessageHeader, MedComMessagingProvenance, MedComMessagingOrganization) - 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.1 from 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-acknowledgement-1 | error | Bundle | If the response.code is different than 'ok', a reference to an OperationOutcome resource shall be included. : iif(entry.resource.ofType(MessageHeader).response.code = 'ok', true, entry.resource.ofType(MessageHeader).response.code != 'ok' and entry.resource.ofType(OperationOutcome).exists()) | |
medcom-acknowledgement-2 | error | Bundle | The message header shall conform to medcom-messaging-acknowledgementHeader profile : entry.resource.ofType(MessageHeader).conformsTo('http://medcomfhir.dk/ig/acknowledgement/StructureDefinition/medcom-messaging-acknowledgementHeader') | |
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() | |
medcom-messaging-3 | error | Bundle | All Provenance resources shall conform to the medcom-messaging-provenance profile : entry.resource.ofType(Provenance).conformsTo('http://medcomfhir.dk/ig/messaging/StructureDefinition/medcom-messaging-provenance').allTrue() |
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-messaging-3: All Provenance resources shall conform to the medcom-messaging-provenance profile medcom-acknowledgement-2: The message header shall conform to medcom-messaging-acknowledgementHeader profile medcom-acknowledgement-1: If the response.code is different than 'ok', a reference to an OperationOutcome resource shall be included. | ||||
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 (MedComAcknowledgementMessageHeader, MedComMessagingProvenance, MedComMessagingOrganization) - 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/languages from the FHIR Standard | ||||
Bundle.type | required | Pattern: messagehttp://hl7.org/fhir/ValueSet/bundle-type|4.0.1 from the FHIR Standard | ||||
Bundle.entry.search.mode | required | SearchEntryModehttp://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1 from the FHIR Standard | ||||
Bundle.entry.request.method | required | HTTPVerbhttp://hl7.org/fhir/ValueSet/http-verb|4.0.1 from 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-acknowledgement-1 | error | Bundle | If the response.code is different than 'ok', a reference to an OperationOutcome resource shall be included. : iif(entry.resource.ofType(MessageHeader).response.code = 'ok', true, entry.resource.ofType(MessageHeader).response.code != 'ok' and entry.resource.ofType(OperationOutcome).exists()) | |
medcom-acknowledgement-2 | error | Bundle | The message header shall conform to medcom-messaging-acknowledgementHeader profile : entry.resource.ofType(MessageHeader).conformsTo('http://medcomfhir.dk/ig/acknowledgement/StructureDefinition/medcom-messaging-acknowledgementHeader') | |
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() | |
medcom-messaging-3 | error | Bundle | All Provenance resources shall conform to the medcom-messaging-provenance profile : entry.resource.ofType(Provenance).conformsTo('http://medcomfhir.dk/ig/messaging/StructureDefinition/medcom-messaging-provenance').allTrue() |
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-acknowledgement-2: The message header shall conform to medcom-messaging-acknowledgementHeader profile medcom-acknowledgement-1: If the response.code is different than 'ok', a reference to an OperationOutcome resource shall be included. |
entry | 0..* | BackboneElement | Message content (MedComAcknowledgementMessageHeader, MedComMessagingProvenance, MedComMessagingOrganization) - Open | |
Documentation for this format |
Id | Grade | Path(s) | Details | Requirements |
medcom-acknowledgement-1 | error | Bundle | If the response.code is different than 'ok', a reference to an OperationOutcome resource shall be included. : iif(entry.resource.ofType(MessageHeader).response.code = 'ok', true, entry.resource.ofType(MessageHeader).response.code != 'ok' and entry.resource.ofType(OperationOutcome).exists()) | |
medcom-acknowledgement-2 | error | Bundle | The message header shall conform to medcom-messaging-acknowledgementHeader profile : entry.resource.ofType(MessageHeader).conformsTo('http://medcomfhir.dk/ig/acknowledgement/StructureDefinition/medcom-messaging-acknowledgementHeader') |
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-messaging-3: All Provenance resources shall conform to the medcom-messaging-provenance profile medcom-acknowledgement-2: The message header shall conform to medcom-messaging-acknowledgementHeader profile medcom-acknowledgement-1: If the response.code is different than 'ok', a reference to an OperationOutcome resource shall be included. |
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 (MedComAcknowledgementMessageHeader, MedComMessagingProvenance, MedComMessagingOrganization) - 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.1 from 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-acknowledgement-1 | error | Bundle | If the response.code is different than 'ok', a reference to an OperationOutcome resource shall be included. : iif(entry.resource.ofType(MessageHeader).response.code = 'ok', true, entry.resource.ofType(MessageHeader).response.code != 'ok' and entry.resource.ofType(OperationOutcome).exists()) | |
medcom-acknowledgement-2 | error | Bundle | The message header shall conform to medcom-messaging-acknowledgementHeader profile : entry.resource.ofType(MessageHeader).conformsTo('http://medcomfhir.dk/ig/acknowledgement/StructureDefinition/medcom-messaging-acknowledgementHeader') | |
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() | |
medcom-messaging-3 | error | Bundle | All Provenance resources shall conform to the medcom-messaging-provenance profile : entry.resource.ofType(Provenance).conformsTo('http://medcomfhir.dk/ig/messaging/StructureDefinition/medcom-messaging-provenance').allTrue() |
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-messaging-3: All Provenance resources shall conform to the medcom-messaging-provenance profile medcom-acknowledgement-2: The message header shall conform to medcom-messaging-acknowledgementHeader profile medcom-acknowledgement-1: If the response.code is different than 'ok', a reference to an OperationOutcome resource shall be included. | ||||
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 (MedComAcknowledgementMessageHeader, MedComMessagingProvenance, MedComMessagingOrganization) - 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/languages from the FHIR Standard | ||||
Bundle.type | required | Pattern: messagehttp://hl7.org/fhir/ValueSet/bundle-type|4.0.1 from the FHIR Standard | ||||
Bundle.entry.search.mode | required | SearchEntryModehttp://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1 from the FHIR Standard | ||||
Bundle.entry.request.method | required | HTTPVerbhttp://hl7.org/fhir/ValueSet/http-verb|4.0.1 from 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-acknowledgement-1 | error | Bundle | If the response.code is different than 'ok', a reference to an OperationOutcome resource shall be included. : iif(entry.resource.ofType(MessageHeader).response.code = 'ok', true, entry.resource.ofType(MessageHeader).response.code != 'ok' and entry.resource.ofType(OperationOutcome).exists()) | |
medcom-acknowledgement-2 | error | Bundle | The message header shall conform to medcom-messaging-acknowledgementHeader profile : entry.resource.ofType(MessageHeader).conformsTo('http://medcomfhir.dk/ig/acknowledgement/StructureDefinition/medcom-messaging-acknowledgementHeader') | |
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() | |
medcom-messaging-3 | error | Bundle | All Provenance resources shall conform to the medcom-messaging-provenance profile : entry.resource.ofType(Provenance).conformsTo('http://medcomfhir.dk/ig/messaging/StructureDefinition/medcom-messaging-provenance').allTrue() |
This structure is derived from MedComMessagingMessage
Other representations of profile: CSV, Excel, Schematron