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-acknowledgement-message-definition | Version: 2.0.3 | |||
Active as of 2024-09-25 | Computable Name: MedComAcknowledgementMessageDefinition |
The MessageDefinition for a MedCom Acknowledgement message
This MessageDefinition profile defines the characteristics of a message that can be shared between systems. This profile should not be included in the exchange of an Acknowledgement message, but can be used to extract relevant information concerning the message, for usage in the VANSEnvelope. The MedComAcknowledgementMessageHeader profile includes an required url to this profile in the element MessageHeader.definition.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from MedComMessagingMessageDefinitionFhir
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
MessageDefinition | 0..* | MedComMessagingMessageDefinitionFhir | A resource that defines a type of message that can be exchanged between systems | |
id | 0..1 | id | Logical id of this artifact Required Pattern: MedComAcknowledgementMessageDefinition | |
url | 0..1 | uri | Business Identifier for a given MessageDefinition Required Pattern: urn:dk:healthcare:medcom:messaging:fhir:structuredefinition:acknowledgement:2.0 | |
identifier | ||||
use | 1..1 | code | usual | official | temp | secondary | old (If known) Required Pattern: official | |
value | 1..1 | string | The value that is unique Required Pattern: Acknowledgement | |
period | ||||
start | 1..1 | dateTime | Starting time with inclusive boundary Required Pattern: 2024-06-18 | |
version | 1..1 | string | Business version of the message definition Required Pattern: 2.0 | |
title | 1..1 | string | Name for this message definition (human friendly) Required Pattern: Acknowledgement 2.0 | |
status | 1..1 | code | draft | active | retired | unknown Required Pattern: active | |
date | 1..1 | dateTime | Date last changed Required Pattern: 2024-09-04 | |
Slices for contact | Content/Rules for all slices | |||
contact:InteroperabilityConsultant | 0..1 | ContactDetail | Contact details for the publisher | |
name | 1..1 | string | Name of an individual to contact Required Pattern: Thea Sørensen | |
telecom | ||||
value | 1..1 | string | The actual contact point details Required Pattern: tms@medcom.dk | |
description | 0..1 | markdown | Natural language description of the message definition Required Pattern: DK: Acknowledgement (RUSA Standardkatalog - Beskrivelse jf. §3stk2 i bekendtgørelsen) | |
useContext | ||||
Slices for value[x] | 1..1 | CodeableConcept, Quantity, Range, Reference(PlanDefinition | ResearchStudy | InsurancePlan | HealthcareService | Group | Location | Organization) | Value that defines the context Slice: Unordered, Open by type:$this | |
value[x]:valueCodeableConcept | 0..1 | CodeableConcept | Value that defines the context | |
text | 0..1 | string | Plain text representation of the concept Required Pattern: DK: Alle sundhedsvæsnets parter der er involverede i behandling og omsorg af borgere eller patienter, herunder læger, hjemmepleje, fysioterapeuter, ergoterapeuter, plejeteam, sygeplejersker, psykologer, psykiater og mange flere. (Hvem skal anvende standarden jf. §3,3 i bekendtgørelsen) | |
purpose | 0..1 | markdown | Why this message definition is defined Required Pattern: DK: At kvittere for en modtaget meddelelse samt, om overførslen af meddelelsen var vellykket, og om meddelelsen validerede korrekt eller ej. MedCom Acknowledgement standard skal sendes hver gang et system har modtaget en MedCom FHIR-meddelelse eksempelvis HospitalNotification og CareCommunication. (RUSA Standardkatalog - Hvad skal standarden anvendes til jf. §3,2 i bekendtgørelsen) | |
copyright | 0..1 | markdown | Use and/or publishing restrictions Required Pattern: Copyright © 2024 MedCom | |
Slices for event[x] | 1..1 | Coding, uri | Event code or link to the EventDefinition Slice: Unordered, Open by type:$this | |
event[x]:eventCoding | 0..1 | Coding | Event code or link to the EventDefinition Required Pattern: At least the following | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://medcomfhir.dk/ig/terminology/CodeSystem/medcom-messaging-eventCodes | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: acknowledgement-message | |
display | 1..1 | string | Representation defined by the system Fixed Value: Acknowledgement Message | |
responseRequired | 1..1 | code | always | on-error | never | on-success Required Pattern: never | |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
MessageDefinition | C | 0..* | MedComMessagingMessageDefinitionFhir | A resource that defines a type of message that can be exchanged between systems msd-0: Name should be usable as an identifier for the module by machine processing applications such as code generation |
id | Σ | 0..1 | id | Logical id of this artifact Required Pattern: MedComAcknowledgementMessageDefinition |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
url | Σ | 0..1 | uri | Business Identifier for a given MessageDefinition Required Pattern: urn:dk:healthcare:medcom:messaging:fhir:structuredefinition:acknowledgement:2.0 |
identifier | SΣ | 1..1 | Identifier | Primary key for the message definition on a given server |
use | ?!SΣ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Required Pattern: official |
type | SΣ | 1..1 | CodeableConcept | Description of identifier Binding: MedComMessageDefinitionTypeValueset (required) Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://medcomfhir.dk/ig/terminology/CodeSystem/medcom-message-definition-type | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: FHIR | |
system | Σ | 1..1 | uri | The namespace for the identifier value Binding: MessageDefinitionIdentifierSystemValueset (required) Fixed Value: urn:dk:healthcare:medcom:messaging:fhir |
value | SΣ | 1..1 | string | The value that is unique Required Pattern: Acknowledgement |
period | Σ | 0..1 | Period | Time period when id is/was valid for use |
start | SΣC | 1..1 | dateTime | Starting time with inclusive boundary Required Pattern: 2024-06-18 |
end | SΣC | 0..1 | dateTime | End time with inclusive boundary, if not ongoing |
version | SΣ | 1..1 | string | Business version of the message definition Required Pattern: 2.0 |
title | SΣ | 1..1 | string | Name for this message definition (human friendly) Required Pattern: Acknowledgement 2.0 |
replaces | Σ | 0..* | canonical(MessageDefinition) | Takes the place of |
value | S | 0..1 | string | Primitive value for canonical |
status | ?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. Required Pattern: active |
date | Σ | 1..1 | dateTime | Date last changed Required Pattern: 2024-09-04 |
publisher | SΣ | 1..1 | string | Name of the publisher (organization or individual) Required Pattern: MedCom, https://www.medcom.dk |
Slices for contact | SΣ | 0..* | ContactDetail | Contact details for the publisher Slice: Unordered, Open by value:id |
contact:InteroperabilityConsultant | SΣ | 0..1 | ContactDetail | Contact details for the publisher |
id | S | 1..1 | string | Unique id for inter-element referencing Required Pattern: InteroperabilityConsultant |
name | SΣ | 1..1 | string | Name of an individual to contact Required Pattern: Thea Sørensen |
telecom | Σ | 0..* | ContactPoint | Contact details for individual or organization |
system | SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: email |
value | SΣ | 1..1 | string | The actual contact point details Required Pattern: tms@medcom.dk |
use | ?!SΣ | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. Fixed Value: work |
contact:SubjectMatterExpert | SΣ | 0..1 | ContactDetail | Contact details for the publisher |
id | S | 1..1 | string | Unique id for inter-element referencing Required Pattern: SubjectMatterExpert |
name | SΣ | 1..1 | string | Name of an individual to contact |
telecom | Σ | 0..* | ContactPoint | Contact details for individual or organization |
system | SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: email |
value | SΣ | 1..1 | string | The actual contact point details |
use | ?!SΣ | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. Fixed Value: work |
description | Σ | 0..1 | markdown | Natural language description of the message definition Required Pattern: DK: Acknowledgement (RUSA Standardkatalog - Beskrivelse jf. §3stk2 i bekendtgørelsen) |
jurisdiction | SΣ | 1..1 | CodeableConcept | Intended jurisdiction for message definition (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use. Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: DK | |
purpose | Σ | 0..1 | markdown | Why this message definition is defined Required Pattern: DK: At kvittere for en modtaget meddelelse samt, om overførslen af meddelelsen var vellykket, og om meddelelsen validerede korrekt eller ej. MedCom Acknowledgement standard skal sendes hver gang et system har modtaget en MedCom FHIR-meddelelse eksempelvis HospitalNotification og CareCommunication. (RUSA Standardkatalog - Hvad skal standarden anvendes til jf. §3,2 i bekendtgørelsen) |
copyright | 0..1 | markdown | Use and/or publishing restrictions Required Pattern: Copyright © 2024 MedCom | |
Slices for event[x] | Σ | 1..1 | Event code or link to the EventDefinition Slice: Unordered, Open by type:$this Binding: MessageEvent (example): One of the message events defined as part of this version of FHIR. | |
eventCoding | Coding | |||
eventUri | uri | |||
event[x]:eventCoding | Σ | 0..1 | Coding | Event code or link to the EventDefinition Binding: MessageEvent (example): One of the message events defined as part of this version of FHIR. Required Pattern: At least the following |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://medcomfhir.dk/ig/terminology/CodeSystem/medcom-messaging-eventCodes | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: acknowledgement-message | |
display | 1..1 | string | Representation defined by the system Fixed Value: Acknowledgement Message | |
category | SΣ | 1..1 | code | consequence | currency | notification Binding: MessageSignificanceCategory (required): The impact of the content of a message. Fixed Value: notification |
responseRequired | S | 1..1 | code | always | on-error | never | on-success Binding: messageheader-response-request (required): HL7-defined table of codes which identify conditions under which acknowledgments are required to be returned in response to a message. Required Pattern: never |
Documentation for this format |
Path | Conformance | ValueSet / Code | URI |
MessageDefinition.identifier.use | required | Pattern: officialhttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | |
MessageDefinition.identifier.type | required | Pattern: FHIRhttp://medcomfhir.dk/ig/terminology/ValueSet/medcom-message-definition-type-valueset | |
MessageDefinition.identifier.system | required | Fixed Value: urn:dk:healthcare:medcom:messaging:fhirhttp://medcomfhir.dk/ig/terminology/ValueSet/medcom-messagedefinition-identifer-system-valueset | |
MessageDefinition.status | required | Pattern: activehttp://hl7.org/fhir/ValueSet/publication-status|4.0.1 from the FHIR Standard | |
MessageDefinition.contact:InteroperabilityConsultant.telecom.system | required | Fixed Value: emailhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard | |
MessageDefinition.contact:InteroperabilityConsultant.telecom.use | required | Fixed Value: workhttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard | |
MessageDefinition.contact:SubjectMatterExpert.telecom.system | required | Fixed Value: emailhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard | |
MessageDefinition.contact:SubjectMatterExpert.telecom.use | required | Fixed Value: workhttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard | |
MessageDefinition.jurisdiction | extensible | Pattern: DKhttp://hl7.org/fhir/ValueSet/jurisdiction from the FHIR Standard | |
MessageDefinition.event[x] | example | MessageEventhttp://hl7.org/fhir/ValueSet/message-events from the FHIR Standard | |
MessageDefinition.event[x]:eventCoding | example | Pattern: acknowledgement-message("Acknowledgement Message")http://hl7.org/fhir/ValueSet/message-events from the FHIR Standard | |
MessageDefinition.category | required | Fixed Value: notificationhttp://hl7.org/fhir/ValueSet/message-significance-category|4.0.1 from the FHIR Standard | |
MessageDefinition.responseRequired | required | Pattern: neverhttp://hl7.org/fhir/ValueSet/messageheader-response-request|4.0.1 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | MessageDefinition | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | MessageDefinition | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | MessageDefinition | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | MessageDefinition | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | MessageDefinition | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
msd-0 | warning | MessageDefinition | Name should be usable as an identifier for the module by machine processing applications such as code generation : name.matches('[A-Z]([A-Za-z0-9_]){0,254}') |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
MessageDefinition | C | 0..* | MedComMessagingMessageDefinitionFhir | A resource that defines a type of message that can be exchanged between systems msd-0: Name should be usable as an identifier for the module by machine processing applications such as code generation | ||||
id | Σ | 0..1 | id | Logical id of this artifact Required Pattern: MedComAcknowledgementMessageDefinition | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
url | Σ | 0..1 | uri | Business Identifier for a given MessageDefinition Required Pattern: urn:dk:healthcare:medcom:messaging:fhir:structuredefinition:acknowledgement:2.0 | ||||
identifier | SΣ | 1..1 | Identifier | Primary key for the message definition on a given server | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!SΣ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Required Pattern: official | ||||
type | SΣ | 1..1 | CodeableConcept | Description of identifier Binding: MedComMessageDefinitionTypeValueset (required) Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://medcomfhir.dk/ig/terminology/CodeSystem/medcom-message-definition-type | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: FHIR | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 0..1 | uri | Identity of the terminology system Required Pattern: http://medcomfhir.dk/ig/terminology/CodeSystem/medcom-message-definition-type | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 0..1 | code | Symbol in syntax defined by the system | ||||
display | Σ | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
system | Σ | 1..1 | uri | The namespace for the identifier value Binding: MessageDefinitionIdentifierSystemValueset (required) Fixed Value: urn:dk:healthcare:medcom:messaging:fhir | ||||
value | SΣ | 1..1 | string | The value that is unique Required Pattern: Acknowledgement | ||||
period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
start | SΣC | 1..1 | dateTime | Starting time with inclusive boundary Required Pattern: 2024-06-18 | ||||
end | SΣC | 0..1 | dateTime | End time with inclusive boundary, if not ongoing | ||||
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
version | SΣ | 1..1 | string | Business version of the message definition Required Pattern: 2.0 | ||||
name | ΣC | 0..1 | string | Name for this message definition (computer friendly) | ||||
title | SΣ | 1..1 | string | Name for this message definition (human friendly) Required Pattern: Acknowledgement 2.0 | ||||
replaces | Σ | 0..* | canonical(MessageDefinition) | Takes the place of | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
value | S | 0..1 | string | Primitive value for canonical | ||||
status | ?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. Required Pattern: active | ||||
experimental | Σ | 0..1 | boolean | For testing purposes, not real usage | ||||
date | Σ | 1..1 | dateTime | Date last changed Required Pattern: 2024-09-04 | ||||
publisher | SΣ | 1..1 | string | Name of the publisher (organization or individual) Required Pattern: MedCom, https://www.medcom.dk | ||||
Slices for contact | SΣ | 0..* | ContactDetail | Contact details for the publisher Slice: Unordered, Open by value:id | ||||
contact:InteroperabilityConsultant | SΣ | 0..1 | ContactDetail | Contact details for the publisher | ||||
id | S | 1..1 | string | Unique id for inter-element referencing Required Pattern: InteroperabilityConsultant | ||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
name | SΣ | 1..1 | string | Name of an individual to contact Required Pattern: Thea Sørensen | ||||
telecom | Σ | 0..* | ContactPoint | Contact details for individual or organization | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: email | ||||
value | SΣ | 1..1 | string | The actual contact point details Required Pattern: tms@medcom.dk | ||||
use | ?!SΣ | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. Fixed Value: work | ||||
rank | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
period | Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
contact:SubjectMatterExpert | SΣ | 0..1 | ContactDetail | Contact details for the publisher | ||||
id | S | 1..1 | string | Unique id for inter-element referencing Required Pattern: SubjectMatterExpert | ||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
name | SΣ | 1..1 | string | Name of an individual to contact | ||||
telecom | Σ | 0..* | ContactPoint | Contact details for individual or organization | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: email | ||||
value | SΣ | 1..1 | string | The actual contact point details | ||||
use | ?!SΣ | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. Fixed Value: work | ||||
rank | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
period | Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
description | Σ | 0..1 | markdown | Natural language description of the message definition Required Pattern: DK: Acknowledgement (RUSA Standardkatalog - Beskrivelse jf. §3stk2 i bekendtgørelsen) | ||||
useContext | Σ | 0..* | UsageContext | The context that the content is intended to support | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
code | Σ | 1..1 | Coding | Type of context being specified Binding: UseContextCodeSystemValueset (required) Fixed Value: As shown (Workflow Setting) | ||||
id | 0..0 | string | Unique id for inter-element referencing | |||||
extension | 0..0 | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/usage-context-type | |||||
version | 0..0 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: workflow | |||||
display | 0..0 | string | Representation defined by the system | |||||
userSelected | 0..0 | boolean | If this coding was chosen directly by the user | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 0..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/usage-context-type | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 0..1 | code | Symbol in syntax defined by the system | ||||
display | Σ | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
Slices for value[x] | Σ | 1..1 | Value that defines the context Slice: Unordered, Open by type:$this Binding: Context of Use ValueSet (example): A code that defines the specific value for the context being specified. | |||||
valueCodeableConcept | CodeableConcept | |||||||
valueQuantity | Quantity | |||||||
valueRange | Range | |||||||
valueReference | Reference(PlanDefinition | ResearchStudy | InsurancePlan | HealthcareService | Group | Location | Organization) | |||||||
value[x]:valueCodeableConcept | Σ | 0..1 | CodeableConcept | Value that defines the context Binding: Context of Use ValueSet (example): A code that defines the specific value for the context being specified. | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
text | Σ | 0..1 | string | Plain text representation of the concept Required Pattern: DK: Alle sundhedsvæsnets parter der er involverede i behandling og omsorg af borgere eller patienter, herunder læger, hjemmepleje, fysioterapeuter, ergoterapeuter, plejeteam, sygeplejersker, psykologer, psykiater og mange flere. (Hvem skal anvende standarden jf. §3,3 i bekendtgørelsen) | ||||
jurisdiction | SΣ | 1..1 | CodeableConcept | Intended jurisdiction for message definition (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use. Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 0..1 | uri | Identity of the terminology system | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: DK | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
purpose | Σ | 0..1 | markdown | Why this message definition is defined Required Pattern: DK: At kvittere for en modtaget meddelelse samt, om overførslen af meddelelsen var vellykket, og om meddelelsen validerede korrekt eller ej. MedCom Acknowledgement standard skal sendes hver gang et system har modtaget en MedCom FHIR-meddelelse eksempelvis HospitalNotification og CareCommunication. (RUSA Standardkatalog - Hvad skal standarden anvendes til jf. §3,2 i bekendtgørelsen) | ||||
copyright | 0..1 | markdown | Use and/or publishing restrictions Required Pattern: Copyright © 2024 MedCom | |||||
base | Σ | 0..1 | canonical(MessageDefinition) | Definition this one is based on | ||||
parent | Σ | 0..* | canonical(ActivityDefinition | PlanDefinition) | Protocol/workflow this is part of | ||||
Slices for event[x] | Σ | 1..1 | Event code or link to the EventDefinition Slice: Unordered, Open by type:$this Binding: MessageEvent (example): One of the message events defined as part of this version of FHIR. | |||||
eventCoding | Coding | |||||||
eventUri | uri | |||||||
event[x]:eventCoding | Σ | 0..1 | Coding | Event code or link to the EventDefinition Binding: MessageEvent (example): One of the message events defined as part of this version of FHIR. Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://medcomfhir.dk/ig/terminology/CodeSystem/medcom-messaging-eventCodes | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: acknowledgement-message | |||||
display | 1..1 | string | Representation defined by the system Fixed Value: Acknowledgement Message | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
category | SΣ | 1..1 | code | consequence | currency | notification Binding: MessageSignificanceCategory (required): The impact of the content of a message. Fixed Value: notification | ||||
focus | ΣC | 0..* | BackboneElement | Resource(s) that are the subject of the event md-1: Max must be postive int or * | ||||
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 | ||||
code | Σ | 1..1 | code | Type of resource Binding: ResourceType (required): One of the resource types defined as part of this version of FHIR. | ||||
profile | 0..1 | canonical(StructureDefinition) | Profile that must be adhered to by focus | |||||
min | Σ | 1..1 | unsignedInt | Minimum number of focuses of this type | ||||
max | C | 0..1 | string | Maximum number of focuses of this type | ||||
responseRequired | S | 1..1 | code | always | on-error | never | on-success Binding: messageheader-response-request (required): HL7-defined table of codes which identify conditions under which acknowledgments are required to be returned in response to a message. Required Pattern: never | ||||
allowedResponse | 0..* | BackboneElement | Responses to this message | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
message | 1..1 | canonical(MessageDefinition) | Reference to allowed message definition response | |||||
situation | 0..1 | markdown | When should this response be used | |||||
graph | 0..* | canonical(GraphDefinition) | Canonical reference to a GraphDefinition | |||||
Documentation for this format |
Path | Conformance | ValueSet / Code | URI | |||
MessageDefinition.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
MessageDefinition.identifier.use | required | Pattern: officialhttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
MessageDefinition.identifier.type | required | Pattern: FHIRhttp://medcomfhir.dk/ig/terminology/ValueSet/medcom-message-definition-type-valueset | ||||
MessageDefinition.identifier.system | required | Fixed Value: urn:dk:healthcare:medcom:messaging:fhirhttp://medcomfhir.dk/ig/terminology/ValueSet/medcom-messagedefinition-identifer-system-valueset | ||||
MessageDefinition.status | required | Pattern: activehttp://hl7.org/fhir/ValueSet/publication-status|4.0.1 from the FHIR Standard | ||||
MessageDefinition.contact:InteroperabilityConsultant.telecom.system | required | Fixed Value: emailhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard | ||||
MessageDefinition.contact:InteroperabilityConsultant.telecom.use | required | Fixed Value: workhttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard | ||||
MessageDefinition.contact:SubjectMatterExpert.telecom.system | required | Fixed Value: emailhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard | ||||
MessageDefinition.contact:SubjectMatterExpert.telecom.use | required | Fixed Value: workhttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard | ||||
MessageDefinition.useContext.code | required | Fixed Value: workflowhttp://medcomfhir.dk/ig/terminology/ValueSet/medcom-messagedefinition-use-context-code-valueset | ||||
MessageDefinition.useContext.value[x] | example | Context of Use ValueSethttp://hl7.org/fhir/ValueSet/use-context from the FHIR Standard | ||||
MessageDefinition.useContext.value[x]:valueCodeableConcept | example | Context of Use ValueSethttp://hl7.org/fhir/ValueSet/use-context from the FHIR Standard | ||||
MessageDefinition.jurisdiction | extensible | Pattern: DKhttp://hl7.org/fhir/ValueSet/jurisdiction from the FHIR Standard | ||||
MessageDefinition.event[x] | example | MessageEventhttp://hl7.org/fhir/ValueSet/message-events from the FHIR Standard | ||||
MessageDefinition.event[x]:eventCoding | example | Pattern: acknowledgement-message("Acknowledgement Message")http://hl7.org/fhir/ValueSet/message-events from the FHIR Standard | ||||
MessageDefinition.category | required | Fixed Value: notificationhttp://hl7.org/fhir/ValueSet/message-significance-category|4.0.1 from the FHIR Standard | ||||
MessageDefinition.focus.code | required | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types|4.0.1 from the FHIR Standard | ||||
MessageDefinition.responseRequired | required | Pattern: neverhttp://hl7.org/fhir/ValueSet/messageheader-response-request|4.0.1 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | MessageDefinition | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | MessageDefinition | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | MessageDefinition | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | MessageDefinition | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | MessageDefinition | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
md-1 | error | MessageDefinition.focus | Max must be postive int or * : max='*' or (max.toInteger() > 0) | |
msd-0 | warning | MessageDefinition | Name should be usable as an identifier for the module by machine processing applications such as code generation : name.matches('[A-Z]([A-Za-z0-9_]){0,254}') |
This structure is derived from MedComMessagingMessageDefinitionFhir
Summary
Slices
This structure defines the following Slices:
Differential View
This structure is derived from MedComMessagingMessageDefinitionFhir
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
MessageDefinition | 0..* | MedComMessagingMessageDefinitionFhir | A resource that defines a type of message that can be exchanged between systems | |
id | 0..1 | id | Logical id of this artifact Required Pattern: MedComAcknowledgementMessageDefinition | |
url | 0..1 | uri | Business Identifier for a given MessageDefinition Required Pattern: urn:dk:healthcare:medcom:messaging:fhir:structuredefinition:acknowledgement:2.0 | |
identifier | ||||
use | 1..1 | code | usual | official | temp | secondary | old (If known) Required Pattern: official | |
value | 1..1 | string | The value that is unique Required Pattern: Acknowledgement | |
period | ||||
start | 1..1 | dateTime | Starting time with inclusive boundary Required Pattern: 2024-06-18 | |
version | 1..1 | string | Business version of the message definition Required Pattern: 2.0 | |
title | 1..1 | string | Name for this message definition (human friendly) Required Pattern: Acknowledgement 2.0 | |
status | 1..1 | code | draft | active | retired | unknown Required Pattern: active | |
date | 1..1 | dateTime | Date last changed Required Pattern: 2024-09-04 | |
Slices for contact | Content/Rules for all slices | |||
contact:InteroperabilityConsultant | 0..1 | ContactDetail | Contact details for the publisher | |
name | 1..1 | string | Name of an individual to contact Required Pattern: Thea Sørensen | |
telecom | ||||
value | 1..1 | string | The actual contact point details Required Pattern: tms@medcom.dk | |
description | 0..1 | markdown | Natural language description of the message definition Required Pattern: DK: Acknowledgement (RUSA Standardkatalog - Beskrivelse jf. §3stk2 i bekendtgørelsen) | |
useContext | ||||
Slices for value[x] | 1..1 | CodeableConcept, Quantity, Range, Reference(PlanDefinition | ResearchStudy | InsurancePlan | HealthcareService | Group | Location | Organization) | Value that defines the context Slice: Unordered, Open by type:$this | |
value[x]:valueCodeableConcept | 0..1 | CodeableConcept | Value that defines the context | |
text | 0..1 | string | Plain text representation of the concept Required Pattern: DK: Alle sundhedsvæsnets parter der er involverede i behandling og omsorg af borgere eller patienter, herunder læger, hjemmepleje, fysioterapeuter, ergoterapeuter, plejeteam, sygeplejersker, psykologer, psykiater og mange flere. (Hvem skal anvende standarden jf. §3,3 i bekendtgørelsen) | |
purpose | 0..1 | markdown | Why this message definition is defined Required Pattern: DK: At kvittere for en modtaget meddelelse samt, om overførslen af meddelelsen var vellykket, og om meddelelsen validerede korrekt eller ej. MedCom Acknowledgement standard skal sendes hver gang et system har modtaget en MedCom FHIR-meddelelse eksempelvis HospitalNotification og CareCommunication. (RUSA Standardkatalog - Hvad skal standarden anvendes til jf. §3,2 i bekendtgørelsen) | |
copyright | 0..1 | markdown | Use and/or publishing restrictions Required Pattern: Copyright © 2024 MedCom | |
Slices for event[x] | 1..1 | Coding, uri | Event code or link to the EventDefinition Slice: Unordered, Open by type:$this | |
event[x]:eventCoding | 0..1 | Coding | Event code or link to the EventDefinition Required Pattern: At least the following | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://medcomfhir.dk/ig/terminology/CodeSystem/medcom-messaging-eventCodes | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: acknowledgement-message | |
display | 1..1 | string | Representation defined by the system Fixed Value: Acknowledgement Message | |
responseRequired | 1..1 | code | always | on-error | never | on-success Required Pattern: never | |
Documentation for this format |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
MessageDefinition | C | 0..* | MedComMessagingMessageDefinitionFhir | A resource that defines a type of message that can be exchanged between systems msd-0: Name should be usable as an identifier for the module by machine processing applications such as code generation |
id | Σ | 0..1 | id | Logical id of this artifact Required Pattern: MedComAcknowledgementMessageDefinition |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
url | Σ | 0..1 | uri | Business Identifier for a given MessageDefinition Required Pattern: urn:dk:healthcare:medcom:messaging:fhir:structuredefinition:acknowledgement:2.0 |
identifier | SΣ | 1..1 | Identifier | Primary key for the message definition on a given server |
use | ?!SΣ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Required Pattern: official |
type | SΣ | 1..1 | CodeableConcept | Description of identifier Binding: MedComMessageDefinitionTypeValueset (required) Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://medcomfhir.dk/ig/terminology/CodeSystem/medcom-message-definition-type | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: FHIR | |
system | Σ | 1..1 | uri | The namespace for the identifier value Binding: MessageDefinitionIdentifierSystemValueset (required) Fixed Value: urn:dk:healthcare:medcom:messaging:fhir |
value | SΣ | 1..1 | string | The value that is unique Required Pattern: Acknowledgement |
period | Σ | 0..1 | Period | Time period when id is/was valid for use |
start | SΣC | 1..1 | dateTime | Starting time with inclusive boundary Required Pattern: 2024-06-18 |
end | SΣC | 0..1 | dateTime | End time with inclusive boundary, if not ongoing |
version | SΣ | 1..1 | string | Business version of the message definition Required Pattern: 2.0 |
title | SΣ | 1..1 | string | Name for this message definition (human friendly) Required Pattern: Acknowledgement 2.0 |
replaces | Σ | 0..* | canonical(MessageDefinition) | Takes the place of |
value | S | 0..1 | string | Primitive value for canonical |
status | ?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. Required Pattern: active |
date | Σ | 1..1 | dateTime | Date last changed Required Pattern: 2024-09-04 |
publisher | SΣ | 1..1 | string | Name of the publisher (organization or individual) Required Pattern: MedCom, https://www.medcom.dk |
Slices for contact | SΣ | 0..* | ContactDetail | Contact details for the publisher Slice: Unordered, Open by value:id |
contact:InteroperabilityConsultant | SΣ | 0..1 | ContactDetail | Contact details for the publisher |
id | S | 1..1 | string | Unique id for inter-element referencing Required Pattern: InteroperabilityConsultant |
name | SΣ | 1..1 | string | Name of an individual to contact Required Pattern: Thea Sørensen |
telecom | Σ | 0..* | ContactPoint | Contact details for individual or organization |
system | SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: email |
value | SΣ | 1..1 | string | The actual contact point details Required Pattern: tms@medcom.dk |
use | ?!SΣ | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. Fixed Value: work |
contact:SubjectMatterExpert | SΣ | 0..1 | ContactDetail | Contact details for the publisher |
id | S | 1..1 | string | Unique id for inter-element referencing Required Pattern: SubjectMatterExpert |
name | SΣ | 1..1 | string | Name of an individual to contact |
telecom | Σ | 0..* | ContactPoint | Contact details for individual or organization |
system | SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: email |
value | SΣ | 1..1 | string | The actual contact point details |
use | ?!SΣ | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. Fixed Value: work |
description | Σ | 0..1 | markdown | Natural language description of the message definition Required Pattern: DK: Acknowledgement (RUSA Standardkatalog - Beskrivelse jf. §3stk2 i bekendtgørelsen) |
jurisdiction | SΣ | 1..1 | CodeableConcept | Intended jurisdiction for message definition (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use. Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: DK | |
purpose | Σ | 0..1 | markdown | Why this message definition is defined Required Pattern: DK: At kvittere for en modtaget meddelelse samt, om overførslen af meddelelsen var vellykket, og om meddelelsen validerede korrekt eller ej. MedCom Acknowledgement standard skal sendes hver gang et system har modtaget en MedCom FHIR-meddelelse eksempelvis HospitalNotification og CareCommunication. (RUSA Standardkatalog - Hvad skal standarden anvendes til jf. §3,2 i bekendtgørelsen) |
copyright | 0..1 | markdown | Use and/or publishing restrictions Required Pattern: Copyright © 2024 MedCom | |
Slices for event[x] | Σ | 1..1 | Event code or link to the EventDefinition Slice: Unordered, Open by type:$this Binding: MessageEvent (example): One of the message events defined as part of this version of FHIR. | |
eventCoding | Coding | |||
eventUri | uri | |||
event[x]:eventCoding | Σ | 0..1 | Coding | Event code or link to the EventDefinition Binding: MessageEvent (example): One of the message events defined as part of this version of FHIR. Required Pattern: At least the following |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://medcomfhir.dk/ig/terminology/CodeSystem/medcom-messaging-eventCodes | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: acknowledgement-message | |
display | 1..1 | string | Representation defined by the system Fixed Value: Acknowledgement Message | |
category | SΣ | 1..1 | code | consequence | currency | notification Binding: MessageSignificanceCategory (required): The impact of the content of a message. Fixed Value: notification |
responseRequired | S | 1..1 | code | always | on-error | never | on-success Binding: messageheader-response-request (required): HL7-defined table of codes which identify conditions under which acknowledgments are required to be returned in response to a message. Required Pattern: never |
Documentation for this format |
Path | Conformance | ValueSet / Code | URI |
MessageDefinition.identifier.use | required | Pattern: officialhttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | |
MessageDefinition.identifier.type | required | Pattern: FHIRhttp://medcomfhir.dk/ig/terminology/ValueSet/medcom-message-definition-type-valueset | |
MessageDefinition.identifier.system | required | Fixed Value: urn:dk:healthcare:medcom:messaging:fhirhttp://medcomfhir.dk/ig/terminology/ValueSet/medcom-messagedefinition-identifer-system-valueset | |
MessageDefinition.status | required | Pattern: activehttp://hl7.org/fhir/ValueSet/publication-status|4.0.1 from the FHIR Standard | |
MessageDefinition.contact:InteroperabilityConsultant.telecom.system | required | Fixed Value: emailhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard | |
MessageDefinition.contact:InteroperabilityConsultant.telecom.use | required | Fixed Value: workhttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard | |
MessageDefinition.contact:SubjectMatterExpert.telecom.system | required | Fixed Value: emailhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard | |
MessageDefinition.contact:SubjectMatterExpert.telecom.use | required | Fixed Value: workhttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard | |
MessageDefinition.jurisdiction | extensible | Pattern: DKhttp://hl7.org/fhir/ValueSet/jurisdiction from the FHIR Standard | |
MessageDefinition.event[x] | example | MessageEventhttp://hl7.org/fhir/ValueSet/message-events from the FHIR Standard | |
MessageDefinition.event[x]:eventCoding | example | Pattern: acknowledgement-message("Acknowledgement Message")http://hl7.org/fhir/ValueSet/message-events from the FHIR Standard | |
MessageDefinition.category | required | Fixed Value: notificationhttp://hl7.org/fhir/ValueSet/message-significance-category|4.0.1 from the FHIR Standard | |
MessageDefinition.responseRequired | required | Pattern: neverhttp://hl7.org/fhir/ValueSet/messageheader-response-request|4.0.1 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | MessageDefinition | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | MessageDefinition | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | MessageDefinition | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | MessageDefinition | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | MessageDefinition | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
msd-0 | warning | MessageDefinition | Name should be usable as an identifier for the module by machine processing applications such as code generation : name.matches('[A-Z]([A-Za-z0-9_]){0,254}') |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
MessageDefinition | C | 0..* | MedComMessagingMessageDefinitionFhir | A resource that defines a type of message that can be exchanged between systems msd-0: Name should be usable as an identifier for the module by machine processing applications such as code generation | ||||
id | Σ | 0..1 | id | Logical id of this artifact Required Pattern: MedComAcknowledgementMessageDefinition | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
url | Σ | 0..1 | uri | Business Identifier for a given MessageDefinition Required Pattern: urn:dk:healthcare:medcom:messaging:fhir:structuredefinition:acknowledgement:2.0 | ||||
identifier | SΣ | 1..1 | Identifier | Primary key for the message definition on a given server | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!SΣ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Required Pattern: official | ||||
type | SΣ | 1..1 | CodeableConcept | Description of identifier Binding: MedComMessageDefinitionTypeValueset (required) Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://medcomfhir.dk/ig/terminology/CodeSystem/medcom-message-definition-type | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: FHIR | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 0..1 | uri | Identity of the terminology system Required Pattern: http://medcomfhir.dk/ig/terminology/CodeSystem/medcom-message-definition-type | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 0..1 | code | Symbol in syntax defined by the system | ||||
display | Σ | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
system | Σ | 1..1 | uri | The namespace for the identifier value Binding: MessageDefinitionIdentifierSystemValueset (required) Fixed Value: urn:dk:healthcare:medcom:messaging:fhir | ||||
value | SΣ | 1..1 | string | The value that is unique Required Pattern: Acknowledgement | ||||
period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
start | SΣC | 1..1 | dateTime | Starting time with inclusive boundary Required Pattern: 2024-06-18 | ||||
end | SΣC | 0..1 | dateTime | End time with inclusive boundary, if not ongoing | ||||
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
version | SΣ | 1..1 | string | Business version of the message definition Required Pattern: 2.0 | ||||
name | ΣC | 0..1 | string | Name for this message definition (computer friendly) | ||||
title | SΣ | 1..1 | string | Name for this message definition (human friendly) Required Pattern: Acknowledgement 2.0 | ||||
replaces | Σ | 0..* | canonical(MessageDefinition) | Takes the place of | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
value | S | 0..1 | string | Primitive value for canonical | ||||
status | ?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. Required Pattern: active | ||||
experimental | Σ | 0..1 | boolean | For testing purposes, not real usage | ||||
date | Σ | 1..1 | dateTime | Date last changed Required Pattern: 2024-09-04 | ||||
publisher | SΣ | 1..1 | string | Name of the publisher (organization or individual) Required Pattern: MedCom, https://www.medcom.dk | ||||
Slices for contact | SΣ | 0..* | ContactDetail | Contact details for the publisher Slice: Unordered, Open by value:id | ||||
contact:InteroperabilityConsultant | SΣ | 0..1 | ContactDetail | Contact details for the publisher | ||||
id | S | 1..1 | string | Unique id for inter-element referencing Required Pattern: InteroperabilityConsultant | ||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
name | SΣ | 1..1 | string | Name of an individual to contact Required Pattern: Thea Sørensen | ||||
telecom | Σ | 0..* | ContactPoint | Contact details for individual or organization | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: email | ||||
value | SΣ | 1..1 | string | The actual contact point details Required Pattern: tms@medcom.dk | ||||
use | ?!SΣ | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. Fixed Value: work | ||||
rank | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
period | Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
contact:SubjectMatterExpert | SΣ | 0..1 | ContactDetail | Contact details for the publisher | ||||
id | S | 1..1 | string | Unique id for inter-element referencing Required Pattern: SubjectMatterExpert | ||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
name | SΣ | 1..1 | string | Name of an individual to contact | ||||
telecom | Σ | 0..* | ContactPoint | Contact details for individual or organization | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: email | ||||
value | SΣ | 1..1 | string | The actual contact point details | ||||
use | ?!SΣ | 1..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. Fixed Value: work | ||||
rank | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
period | Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
description | Σ | 0..1 | markdown | Natural language description of the message definition Required Pattern: DK: Acknowledgement (RUSA Standardkatalog - Beskrivelse jf. §3stk2 i bekendtgørelsen) | ||||
useContext | Σ | 0..* | UsageContext | The context that the content is intended to support | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
code | Σ | 1..1 | Coding | Type of context being specified Binding: UseContextCodeSystemValueset (required) Fixed Value: As shown (Workflow Setting) | ||||
id | 0..0 | string | Unique id for inter-element referencing | |||||
extension | 0..0 | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/usage-context-type | |||||
version | 0..0 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: workflow | |||||
display | 0..0 | string | Representation defined by the system | |||||
userSelected | 0..0 | boolean | If this coding was chosen directly by the user | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 0..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/usage-context-type | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 0..1 | code | Symbol in syntax defined by the system | ||||
display | Σ | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
Slices for value[x] | Σ | 1..1 | Value that defines the context Slice: Unordered, Open by type:$this Binding: Context of Use ValueSet (example): A code that defines the specific value for the context being specified. | |||||
valueCodeableConcept | CodeableConcept | |||||||
valueQuantity | Quantity | |||||||
valueRange | Range | |||||||
valueReference | Reference(PlanDefinition | ResearchStudy | InsurancePlan | HealthcareService | Group | Location | Organization) | |||||||
value[x]:valueCodeableConcept | Σ | 0..1 | CodeableConcept | Value that defines the context Binding: Context of Use ValueSet (example): A code that defines the specific value for the context being specified. | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
text | Σ | 0..1 | string | Plain text representation of the concept Required Pattern: DK: Alle sundhedsvæsnets parter der er involverede i behandling og omsorg af borgere eller patienter, herunder læger, hjemmepleje, fysioterapeuter, ergoterapeuter, plejeteam, sygeplejersker, psykologer, psykiater og mange flere. (Hvem skal anvende standarden jf. §3,3 i bekendtgørelsen) | ||||
jurisdiction | SΣ | 1..1 | CodeableConcept | Intended jurisdiction for message definition (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use. Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 0..1 | uri | Identity of the terminology system | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: DK | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
purpose | Σ | 0..1 | markdown | Why this message definition is defined Required Pattern: DK: At kvittere for en modtaget meddelelse samt, om overførslen af meddelelsen var vellykket, og om meddelelsen validerede korrekt eller ej. MedCom Acknowledgement standard skal sendes hver gang et system har modtaget en MedCom FHIR-meddelelse eksempelvis HospitalNotification og CareCommunication. (RUSA Standardkatalog - Hvad skal standarden anvendes til jf. §3,2 i bekendtgørelsen) | ||||
copyright | 0..1 | markdown | Use and/or publishing restrictions Required Pattern: Copyright © 2024 MedCom | |||||
base | Σ | 0..1 | canonical(MessageDefinition) | Definition this one is based on | ||||
parent | Σ | 0..* | canonical(ActivityDefinition | PlanDefinition) | Protocol/workflow this is part of | ||||
Slices for event[x] | Σ | 1..1 | Event code or link to the EventDefinition Slice: Unordered, Open by type:$this Binding: MessageEvent (example): One of the message events defined as part of this version of FHIR. | |||||
eventCoding | Coding | |||||||
eventUri | uri | |||||||
event[x]:eventCoding | Σ | 0..1 | Coding | Event code or link to the EventDefinition Binding: MessageEvent (example): One of the message events defined as part of this version of FHIR. Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://medcomfhir.dk/ig/terminology/CodeSystem/medcom-messaging-eventCodes | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: acknowledgement-message | |||||
display | 1..1 | string | Representation defined by the system Fixed Value: Acknowledgement Message | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
category | SΣ | 1..1 | code | consequence | currency | notification Binding: MessageSignificanceCategory (required): The impact of the content of a message. Fixed Value: notification | ||||
focus | ΣC | 0..* | BackboneElement | Resource(s) that are the subject of the event md-1: Max must be postive int or * | ||||
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 | ||||
code | Σ | 1..1 | code | Type of resource Binding: ResourceType (required): One of the resource types defined as part of this version of FHIR. | ||||
profile | 0..1 | canonical(StructureDefinition) | Profile that must be adhered to by focus | |||||
min | Σ | 1..1 | unsignedInt | Minimum number of focuses of this type | ||||
max | C | 0..1 | string | Maximum number of focuses of this type | ||||
responseRequired | S | 1..1 | code | always | on-error | never | on-success Binding: messageheader-response-request (required): HL7-defined table of codes which identify conditions under which acknowledgments are required to be returned in response to a message. Required Pattern: never | ||||
allowedResponse | 0..* | BackboneElement | Responses to this message | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
message | 1..1 | canonical(MessageDefinition) | Reference to allowed message definition response | |||||
situation | 0..1 | markdown | When should this response be used | |||||
graph | 0..* | canonical(GraphDefinition) | Canonical reference to a GraphDefinition | |||||
Documentation for this format |
Path | Conformance | ValueSet / Code | URI | |||
MessageDefinition.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
MessageDefinition.identifier.use | required | Pattern: officialhttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
MessageDefinition.identifier.type | required | Pattern: FHIRhttp://medcomfhir.dk/ig/terminology/ValueSet/medcom-message-definition-type-valueset | ||||
MessageDefinition.identifier.system | required | Fixed Value: urn:dk:healthcare:medcom:messaging:fhirhttp://medcomfhir.dk/ig/terminology/ValueSet/medcom-messagedefinition-identifer-system-valueset | ||||
MessageDefinition.status | required | Pattern: activehttp://hl7.org/fhir/ValueSet/publication-status|4.0.1 from the FHIR Standard | ||||
MessageDefinition.contact:InteroperabilityConsultant.telecom.system | required | Fixed Value: emailhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard | ||||
MessageDefinition.contact:InteroperabilityConsultant.telecom.use | required | Fixed Value: workhttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard | ||||
MessageDefinition.contact:SubjectMatterExpert.telecom.system | required | Fixed Value: emailhttp://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard | ||||
MessageDefinition.contact:SubjectMatterExpert.telecom.use | required | Fixed Value: workhttp://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard | ||||
MessageDefinition.useContext.code | required | Fixed Value: workflowhttp://medcomfhir.dk/ig/terminology/ValueSet/medcom-messagedefinition-use-context-code-valueset | ||||
MessageDefinition.useContext.value[x] | example | Context of Use ValueSethttp://hl7.org/fhir/ValueSet/use-context from the FHIR Standard | ||||
MessageDefinition.useContext.value[x]:valueCodeableConcept | example | Context of Use ValueSethttp://hl7.org/fhir/ValueSet/use-context from the FHIR Standard | ||||
MessageDefinition.jurisdiction | extensible | Pattern: DKhttp://hl7.org/fhir/ValueSet/jurisdiction from the FHIR Standard | ||||
MessageDefinition.event[x] | example | MessageEventhttp://hl7.org/fhir/ValueSet/message-events from the FHIR Standard | ||||
MessageDefinition.event[x]:eventCoding | example | Pattern: acknowledgement-message("Acknowledgement Message")http://hl7.org/fhir/ValueSet/message-events from the FHIR Standard | ||||
MessageDefinition.category | required | Fixed Value: notificationhttp://hl7.org/fhir/ValueSet/message-significance-category|4.0.1 from the FHIR Standard | ||||
MessageDefinition.focus.code | required | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types|4.0.1 from the FHIR Standard | ||||
MessageDefinition.responseRequired | required | Pattern: neverhttp://hl7.org/fhir/ValueSet/messageheader-response-request|4.0.1 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | MessageDefinition | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | MessageDefinition | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | MessageDefinition | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | MessageDefinition | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | MessageDefinition | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
md-1 | error | MessageDefinition.focus | Max must be postive int or * : max='*' or (max.toInteger() > 0) | |
msd-0 | warning | MessageDefinition | Name should be usable as an identifier for the module by machine processing applications such as code generation : name.matches('[A-Z]([A-Za-z0-9_]){0,254}') |
This structure is derived from MedComMessagingMessageDefinitionFhir
Summary
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron