DK MedCom HospitalNotification
2.0.0 - Build CI Denmark flag

This page is part of the DK MedCom HospitalNotification (v2.0.0: Release) based on FHIR R4. The current version which supercedes this version is 3.0.0. For a full list of available versions, see the Directory of published versions

Resource Profile: MedComHospitalNotificationMessage

Official URL: http://medcomfhir.dk/ig/hospitalnotification/StructureDefinition/medcom-hospitalNotification-message Version: 2.0.0
Active as of 2022-10-05 Computable Name: MedComHospitalNotificationMessage

A message for a HospitalNotification. The message is triggered as patients are admitted, onleave or has finished a hospital stay in order to notify the relevant Municipalicy home care

Scope and usage

This profile is the root profile of MedCom HospitalNotification message. This profile is inherited from the MedComMessagingMessage. The following figure represent the profiles that shall be included in a MedCom FHIR HospitalNotification message.

Shows the structure of a HospitalNotification message. The MedComHospitalNotificationMessage includes a MedComHospitalNotificationMessageHeader and a MedComMessagingProvenance. MedComHospitalNotificationMessageHeader references a sender and receiver organization in terms of the MedComMessagingOrganization, and a focus which is a reference to a MedComHospitalNotificationEncounter. From the MedComHospitalNotificationEncounter is a MedComCorePatient and a MedComCoreOrganization referenced.

The Bundle containing the HospitalNotification message is selfcontained, why it shall contain one instance of the MedComHospitalNotificationMessageHeader. By convention the cardinality is shown as 0..*.

Please refer to the tab “Snapshot Table(Must support)” below for the definition of the required content of a MedComHospitalNotificationMessage.

Usage:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from MedComMessagingMessage

Summary

This structure is derived from MedComMessagingMessage

NameFlagsCard.TypeDescription & Constraintsdoco
.. Bundle C0..*MedComMessagingMessageContains a collection of resources
medcom-hospitalNotification-1: The message header shall conform to medcom-hospitalNotification-messageHeader profile
medcom-hospitalNotification-2: Entry shall contain exactly one patient resource
medcom-hospitalNotification-3: All provenance resources shall contain activities from medcom-hospitalNotification-messageActivities valueset
medcom-hospitalNotification-4: The system of Patient.identifier shall be 'urn:oid:1.2.208.176.1.2', which represents an official Danish CPR-number
medcom-hospitalNotification-5: The receiver of a HospitalNotification shall always be a primary receiver.
... id 1..1idA unique identifier for a bundle. The element must be updated with a new value each time a new message is sent.
... timestamp 1..1instantHolds information about when a bundle is created.
... entry 0..*BackboneElementMessage content (MedComHospitalNotificationMessageHeader, MedComMessagingOrganization, MedComMessagingProvenance, MedComHospitalNotificationEncounter, MedComCorePatient) - Open

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Bundle C0..*MedComMessagingMessageContains a collection of resources
medcom-hospitalNotification-1: The message header shall conform to medcom-hospitalNotification-messageHeader profile
medcom-hospitalNotification-2: Entry shall contain exactly one patient resource
medcom-hospitalNotification-3: All provenance resources shall contain activities from medcom-hospitalNotification-messageActivities valueset
medcom-hospitalNotification-4: The system of Patient.identifier shall be 'urn:oid:1.2.208.176.1.2', which represents an official Danish CPR-number
medcom-hospitalNotification-5: The receiver of a HospitalNotification shall always be a primary receiver.
... id SΣ1..1idA unique identifier for a bundle. The element must be updated with a new value each time a new message is sent.
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... identifier Σ0..1IdentifierPersistent identifier for the bundle
... type SΣ1..1codeAlways message
Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used.


Required Pattern: message
... timestamp SΣ1..1instantHolds information about when a bundle is created.
... total ΣC0..1unsignedIntIf search, the total number of matches
... link Σ0..*BackboneElementLinks related to this Bundle
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... relation Σ1..1stringSee http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1
.... url Σ1..1uriReference details for the link
... entry SΣC0..*BackboneElementMessage content (MedComHospitalNotificationMessageHeader, MedComMessagingOrganization, MedComMessagingProvenance, MedComHospitalNotificationEncounter, MedComCorePatient) - Open
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..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... link Σ0..*See link (Bundle)Links related to this entry
.... fullUrl Σ0..1uriURI for resource (Absolute URL server address or URI for UUID/OID)
.... resource SΣ0..1ResourceEach MedCom message shall contain a MedComMessagingMessageHeader and MedComMessagingProvenance. Please refer to invariant medcom-messaging-1, medcom-messaging-2, and medcom-messaging-3.
.... search ΣC0..1BackboneElementSearch related information
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... mode Σ0..1codematch | 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..1decimalSearch ranking (between 0 and 1)
.... request ΣC0..1BackboneElementAdditional execution information (transaction/batch/history)
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... method Σ1..1codeGET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.

..... url Σ1..1uriURL for HTTP equivalent of this entry
..... ifNoneMatch Σ0..1stringFor managing cache currency
..... ifModifiedSince Σ0..1instantFor managing cache currency
..... ifMatch Σ0..1stringFor managing update contention
..... ifNoneExist Σ0..1stringFor conditional creates
.... response ΣC0..1BackboneElementResults of execution (transaction/batch/history)
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... status Σ1..1stringStatus response code (text optional)
..... location Σ0..1uriThe location (if the operation returns a location)
..... etag Σ0..1stringThe Etag for the resource (if relevant)
..... lastModified Σ0..1instantServer's date time modified
..... outcome Σ0..1ResourceOperationOutcome with hints and warnings (for batch/transaction)
... signature Σ0..1SignatureDigital Signature

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Bundle C0..*MedComMessagingMessageContains a collection of resources
medcom-hospitalNotification-1: The message header shall conform to medcom-hospitalNotification-messageHeader profile
medcom-hospitalNotification-2: Entry shall contain exactly one patient resource
medcom-hospitalNotification-3: All provenance resources shall contain activities from medcom-hospitalNotification-messageActivities valueset
medcom-hospitalNotification-4: The system of Patient.identifier shall be 'urn:oid:1.2.208.176.1.2', which represents an official Danish CPR-number
medcom-hospitalNotification-5: The receiver of a HospitalNotification shall always be a primary receiver.
... id Σ1..1idA unique identifier for a bundle. The element must be updated with a new value each time a new message is sent.
... type Σ1..1codeAlways message
Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used.


Required Pattern: message
... timestamp Σ1..1instantHolds information about when a bundle is created.
.... resource Σ0..1ResourceEach MedCom message shall contain a MedComMessagingMessageHeader and MedComMessagingProvenance. Please refer to invariant medcom-messaging-1, medcom-messaging-2, and medcom-messaging-3.

doco Documentation for this format

This structure is derived from MedComMessagingMessage

Summary

Differential View

This structure is derived from MedComMessagingMessage

NameFlagsCard.TypeDescription & Constraintsdoco
.. Bundle C0..*MedComMessagingMessageContains a collection of resources
medcom-hospitalNotification-1: The message header shall conform to medcom-hospitalNotification-messageHeader profile
medcom-hospitalNotification-2: Entry shall contain exactly one patient resource
medcom-hospitalNotification-3: All provenance resources shall contain activities from medcom-hospitalNotification-messageActivities valueset
medcom-hospitalNotification-4: The system of Patient.identifier shall be 'urn:oid:1.2.208.176.1.2', which represents an official Danish CPR-number
medcom-hospitalNotification-5: The receiver of a HospitalNotification shall always be a primary receiver.
... id 1..1idA unique identifier for a bundle. The element must be updated with a new value each time a new message is sent.
... timestamp 1..1instantHolds information about when a bundle is created.
... entry 0..*BackboneElementMessage content (MedComHospitalNotificationMessageHeader, MedComMessagingOrganization, MedComMessagingProvenance, MedComHospitalNotificationEncounter, MedComCorePatient) - Open

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Bundle C0..*MedComMessagingMessageContains a collection of resources
medcom-hospitalNotification-1: The message header shall conform to medcom-hospitalNotification-messageHeader profile
medcom-hospitalNotification-2: Entry shall contain exactly one patient resource
medcom-hospitalNotification-3: All provenance resources shall contain activities from medcom-hospitalNotification-messageActivities valueset
medcom-hospitalNotification-4: The system of Patient.identifier shall be 'urn:oid:1.2.208.176.1.2', which represents an official Danish CPR-number
medcom-hospitalNotification-5: The receiver of a HospitalNotification shall always be a primary receiver.
... id SΣ1..1idA unique identifier for a bundle. The element must be updated with a new value each time a new message is sent.
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... identifier Σ0..1IdentifierPersistent identifier for the bundle
... type SΣ1..1codeAlways message
Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used.


Required Pattern: message
... timestamp SΣ1..1instantHolds information about when a bundle is created.
... total ΣC0..1unsignedIntIf search, the total number of matches
... link Σ0..*BackboneElementLinks related to this Bundle
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... relation Σ1..1stringSee http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1
.... url Σ1..1uriReference details for the link
... entry SΣC0..*BackboneElementMessage content (MedComHospitalNotificationMessageHeader, MedComMessagingOrganization, MedComMessagingProvenance, MedComHospitalNotificationEncounter, MedComCorePatient) - Open
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..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... link Σ0..*See link (Bundle)Links related to this entry
.... fullUrl Σ0..1uriURI for resource (Absolute URL server address or URI for UUID/OID)
.... resource SΣ0..1ResourceEach MedCom message shall contain a MedComMessagingMessageHeader and MedComMessagingProvenance. Please refer to invariant medcom-messaging-1, medcom-messaging-2, and medcom-messaging-3.
.... search ΣC0..1BackboneElementSearch related information
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... mode Σ0..1codematch | 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..1decimalSearch ranking (between 0 and 1)
.... request ΣC0..1BackboneElementAdditional execution information (transaction/batch/history)
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... method Σ1..1codeGET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.

..... url Σ1..1uriURL for HTTP equivalent of this entry
..... ifNoneMatch Σ0..1stringFor managing cache currency
..... ifModifiedSince Σ0..1instantFor managing cache currency
..... ifMatch Σ0..1stringFor managing update contention
..... ifNoneExist Σ0..1stringFor conditional creates
.... response ΣC0..1BackboneElementResults of execution (transaction/batch/history)
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... status Σ1..1stringStatus response code (text optional)
..... location Σ0..1uriThe location (if the operation returns a location)
..... etag Σ0..1stringThe Etag for the resource (if relevant)
..... lastModified Σ0..1instantServer's date time modified
..... outcome Σ0..1ResourceOperationOutcome with hints and warnings (for batch/transaction)
... signature Σ0..1SignatureDigital Signature

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet / Code
Bundle.languagepreferredCommonLanguages
Max Binding: AllLanguages
Bundle.typerequiredPattern: message
Bundle.entry.search.moderequiredSearchEntryMode
Bundle.entry.request.methodrequiredHTTPVerb

Constraints

IdGradePathDetailsRequirements
bdl-1errorBundletotal only when a search or history
: total.empty() or (type = 'searchset') or (type = 'history')
bdl-2errorBundleentry.search only when a search
: entry.search.empty() or (type = 'searchset')
bdl-3errorBundleentry.request mandatory for batch/transaction/history, otherwise prohibited
: entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history'))
bdl-4errorBundleentry.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-7errorBundleFullUrl 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-9errorBundleA document must have an identifier with a system and a value
: type = 'document' implies (identifier.system.exists() and identifier.value.exists())
bdl-10errorBundleA document must have a date
: type = 'document' implies (timestamp.hasValue())
bdl-11errorBundleA document must have a Composition as the first resource
: type = 'document' implies entry.first().resource.is(Composition)
bdl-12errorBundleA message must have a MessageHeader as the first resource
: type = 'message' implies entry.first().resource.is(MessageHeader)
medcom-messaging-1errorBundleThe MessageHeader resource shall conform to medcom-messaging-messageHeader profile
: entry.ofType(MessageHeader).all(resource.conformsTo('http://medcomfhir.dk/fhir/messaging/StructureDefinition/medcom-messaging-messageHeader'))
medcom-messaging-2errorBundleThere shall be at least one Provenance resource in a MedCom message
: entry.resource.ofType(Provenance).exists()
medcom-messaging-3errorBundleAll Provenance resources shall conform to medcom-core-provenance profile
: entry.ofType(Provenance).all(resource.conformsTo('http://medcomfhir.dk/fhir/messaging/StructureDefinition/medcom-messaging-provenance'))
medcom-hospitalNotification-1errorBundleThe message header shall conform to medcom-hospitalNotification-messageHeader profile
: entry.ofType(MessageHeader).all(resource.conformsTo('http://medcomfhir.dk/fhir/hospitalnotification/StructureDefinition/medcom-hospitalNotification-messageHeader'))
medcom-hospitalNotification-2errorBundleEntry shall contain exactly one patient resource
: entry.where(resource.is(Patient)).count() = 1
medcom-hospitalNotification-3errorBundleAll provenance resources shall contain activities from medcom-hospitalNotification-messageActivities valueset
: entry.ofType(Provenance).all(resource.activity.memberOf('http://medcomfhir.dk/fhir/dk-medcom-terminology/ValueSet/medcom-hospitalNotification-messageActivities'))
medcom-hospitalNotification-4errorBundleThe system of Patient.identifier shall be 'urn:oid:1.2.208.176.1.2', which represents an official Danish CPR-number
: entry.resource.ofType(Patient).identifier.system = 'urn:oid:1.2.208.176.1.2'
medcom-hospitalNotification-5errorBundleThe receiver of a HospitalNotification shall always be a primary receiver.
: Bundle.entry.resource.ofType(MessageHeader).destination.extension.value.code = 'primary'
ele-1errorBundle.metaAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorBundle.implicitRulesAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorBundle.languageAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorBundle.identifierAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorBundle.typeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorBundle.timestampAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorBundle.totalAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorBundle.linkAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorBundle.link.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorBundle.link.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorBundle.link.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorBundle.link.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorBundle.link.relationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorBundle.link.urlAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
bdl-5errorBundle.entrymust be a resource unless there's a request or response
: resource.exists() or request.exists() or response.exists()
bdl-8errorBundle.entryfullUrl cannot be a version specific reference
: fullUrl.contains('/_history/').not()
ele-1errorBundle.entryAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorBundle.entry.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorBundle.entry.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorBundle.entry.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorBundle.entry.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorBundle.entry.linkAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorBundle.entry.fullUrlAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorBundle.entry.searchAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorBundle.entry.search.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorBundle.entry.search.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorBundle.entry.search.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorBundle.entry.search.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorBundle.entry.search.modeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorBundle.entry.search.scoreAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorBundle.entry.requestAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorBundle.entry.request.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorBundle.entry.request.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorBundle.entry.request.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorBundle.entry.request.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorBundle.entry.request.methodAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorBundle.entry.request.urlAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorBundle.entry.request.ifNoneMatchAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorBundle.entry.request.ifModifiedSinceAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorBundle.entry.request.ifMatchAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorBundle.entry.request.ifNoneExistAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorBundle.entry.responseAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorBundle.entry.response.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorBundle.entry.response.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorBundle.entry.response.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorBundle.entry.response.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorBundle.entry.response.statusAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorBundle.entry.response.locationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorBundle.entry.response.etagAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorBundle.entry.response.lastModifiedAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorBundle.signatureAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())