Merge pull request #84 from hl7dk/release1.0-Corrections-anj

Release1.0 corrections anj
medcomdk · Jan 29, 2021 · 141f937 · 141f937
2 parents 1ac2617 + 4c7d12d
commit 141f937
Show file tree

Hide file tree

Showing 10 changed files with 79 additions and 9 deletions.
diff --git a/doc/message/common/ReleaseNotes.md b/doc/message/common/ReleaseNotes.md
@@ -0,0 +1,33 @@
+# MedCom FHIR 1.0 Release note
+Release Date: 2020-01-29
+## What&#39;s new in version 1.0 since 0.9.
+Content link: [http://build.fhir.org/ig/hl7dk/dk-medcom/branches/1.0/](http://build.fhir.org/ig/hl7dk/dk-medcom/branches/1.0/)
+ ´#´ refers to the corresponding GitHub issue: [https://github.com/hl7dk/dk-medcom](https://github.com/hl7dk/dk-medcom)
+
+### What&#39;s new
+
+- Updated IG documentation
+- References guide between OIOXML and FHIR created. #66
+- provenance.entry.what.reference changed to NI/NA #61
+- Official Profile URL changed from medcom.dk to medcomfhir.dk #56
+- The following unused activity codes has been removed: #53
+  - discharged to other than home
+  - revise-discharge-emergency-other
+  - revise-discharge-inpatient-other
+  - cancel-discharge-emergency-other
+  - cancel-discharge-inpatient-other
+
+- Cancel and corrections – examples of CareCommunication and Hospital notification has been added. #52
+- Acknowledgement – examples and additional description added #51
+- Report of admission indication added to MessageHeader #42
+- Statistical code value set added #41
+- Optional cc receiver removed from Hospital Notification #40
+- Messaging.organization.identifier – must support added. #39
+- Provenance.entity.what.reference – cardinality changed to 1..1 #36
+- Graphics added to the documentation. #35
+- Additional examples has been added. #33
+- HospitalNotification – LPR3 no longer mandatory #29
+- Encounter.class.system cardinality changed to 1..1 #22
+
+
+
diff --git a/input/fsh/MedComCareCommunication.fsh b/input/fsh/MedComCareCommunication.fsh
@@ -128,13 +128,15 @@ Usage: #inline
 // Practitioners
 Instance: 58c811a5-4082-44eb-9d66-ccbb112d4973
 InstanceOf: Practitioner
+Title: "Simple practitioner with a name"
 Description: "Simple practitioner with a name"
 Usage: #inline
 * name.given = "Michael"
 * name.family = "Burns"
 
 Instance: ad055a3d-16b6-41f9-891a-7dd73eecaf03
 InstanceOf: Practitioner
+Title: "Simple practitioner with a name"
 Description: "Simple practitioner with a name"
 Usage: #inline
 * name.given = "Emma"

diff --git a/input/fsh/MedComCareCommunicationHeader.fsh b/input/fsh/MedComCareCommunicationHeader.fsh
@@ -13,6 +13,7 @@ Description: "Message header for care communication message"
 // CareCommunication example
 Instance: 42cb9200-f421-4d08-8391-7d51a2503cb4
 InstanceOf: MedComCareCommunicationMessageHeader
+Title: "Message header for care communication message. Valid only if used in a bundle (message)."
 Description: "Message header for care communication message. Valid only if used in a bundle (message)."
 * destination.extension[use] = b4e7e16b-9658-4172-acd7-5e7193f2cc5f
 * eventCoding = $MessageEvents#care-communication-message
@@ -25,6 +26,7 @@ Description: "Message header for care communication message. Valid only if used
 // CareCommunication reply example
 Instance: b0d424f8-33a9-4cc2-a528-a6cc1c58727b
 InstanceOf: MedComCareCommunicationMessageHeader
+Title: "Message header for care communication reply message. Valid only if used in a bundle (message)."
 Description: "Message header for care communication reply message. Valid only if used in a bundle (message)."
 Usage: #inline
 * destination.extension[use] = b4e7e16b-9658-4172-acd7-5e7193f2cc5f
@@ -38,6 +40,7 @@ Usage: #inline
 // CareCommunication forward example
 Instance: d5bd2111-2576-48d3-84d4-8be0297a038d
 InstanceOf: MedComCareCommunicationMessageHeader
+Title: "Message header for care communication forward message. Valid only if used in a bundle (message)."
 Description: "Message header for care communication forward message. Valid only if used in a bundle (message)."
 Usage: #inline
 * destination.extension[use] = b4e7e16b-9658-4172-acd7-5e7193f2cc5f

diff --git a/input/fsh/MedComHospitalNotificationMessageHeader.fsh b/input/fsh/MedComHospitalNotificationMessageHeader.fsh
@@ -16,6 +16,7 @@ Description: "Message header for a hospital notification message."
 
 Instance: 51b27813-8aa8-4fa1-846b-aeabf5afb7d4
 InstanceOf: MedComHospitalNotificationMessageHeader
+Title: "Message header for a hospital notification admit message. Valid only if used in a bundle (message)."
 Description: "Message header for a hospital notification admit message. Valid only if used in a bundle (message)."
 * destination.extension[use] = b4e7e16b-9658-4172-acd7-5e7193f2cc5f
 * eventCoding = $MessageEvents#hospital-notification-message
@@ -28,6 +29,7 @@ Description: "Message header for a hospital notification admit message. Valid on
 
 Instance: b563a2b2-bf92-4b13-bbd2-0a021a95bded
 InstanceOf: MedComHospitalNotificationMessageHeader
+Title: "Message header for a hospital notification start leave message. Valid only if used in a bundle (message)"
 Description: "Message header for a hospital notification start leave message. Valid only if used in a bundle (message)."
 * destination.extension[use] = b4e7e16b-9658-4172-acd7-5e7193f2cc5f
 * eventCoding = $MessageEvents#hospital-notification-message
@@ -39,6 +41,7 @@ Description: "Message header for a hospital notification start leave message. Va
 
 Instance: e47254da-f170-46f0-b624-4778a9c92b1f
 InstanceOf: MedComHospitalNotificationMessageHeader
+Title: "Message header for a hospital notification start leave message. Valid only if used in a bundle (message)"
 Description: "Message header for a hospital notification start leave message. Valid only if used in a bundle (message)."
 * destination.extension[use] = b4e7e16b-9658-4172-acd7-5e7193f2cc5f
 * eventCoding = $MessageEvents#hospital-notification-message
@@ -50,6 +53,7 @@ Description: "Message header for a hospital notification start leave message. Va
 
 Instance: 01affa53-c157-4080-abb0-8e681524f969
 InstanceOf: MedComHospitalNotificationMessageHeader
+Title: "Message header for a hospital notification discharge message. Valid only if used in a bundle (message)"
 Description: "Message header for a hospital notification discharge message. Valid only if used in a bundle (message)."
 * destination.extension[use] = b4e7e16b-9658-4172-acd7-5e7193f2cc5f
 * eventCoding = $MessageEvents#hospital-notification-message
@@ -62,6 +66,7 @@ Description: "Message header for a hospital notification discharge message. Vali
 // admit message - for patient that will be discharged as deceased
 Instance: 29b4818e-02de-4cc4-b418-d20cbc7b5404
 InstanceOf: MedComHospitalNotificationMessageHeader
+Title: "Message header for a hospital notification admit message when patient later is deceased. Valid only if used in a bundle (message)"
 Description: "Message header for a hospital notification admit message when patient later is deceased. Valid only if used in a bundle (message)."
 * destination.extension[use] = b4e7e16b-9658-4172-acd7-5e7193f2cc5f
 * eventCoding = $MessageEvents#hospital-notification-message
@@ -75,6 +80,7 @@ Description: "Message header for a hospital notification admit message when pati
 // Discharge message - patient discharged as deceased
 Instance: 8efc6d95-6161-4493-99c9-f359488dedb8
 InstanceOf: MedComHospitalNotificationMessageHeader
+Title: "Message header for a hospital notification discharge message when patient is deceased. Valid only if used in a bundle (message)"
 Description: "Message header for a hospital notification discharge message when patient is deceased. Valid only if used in a bundle (message)."
 * destination.extension[use] = b4e7e16b-9658-4172-acd7-5e7193f2cc5f
 * eventCoding = $MessageEvents#hospital-notification-message

diff --git a/input/fsh/MedComMessagingAcknowledgement.fsh b/input/fsh/MedComMessagingAcknowledgement.fsh
@@ -7,6 +7,7 @@ Description: "Base resource for all MedCom Acknowledgement messages."
 
 Instance: 04ed814c-ccf6-47aa-be73-ae38df23c66a
 InstanceOf: MedComMessagingAcknowledgement
+Title: "Acknowledgement message"
 Description: "Example of a Acknowledgement message."
 * type = $BundleType#message
 * timestamp = 2020-10-01T12:34:56Z
@@ -19,6 +20,7 @@ Description: "Example of a Acknowledgement message."
 
 Instance: 2c9535ef-ed94-4060-a928-7baddec7ee71
 InstanceOf: MedComMessagingAcknowledgement
+Title: "fatal-error Acknowledgement message"
 Description: "Example of a fatal-error Acknowledgement message."
 * type = $BundleType#message
 * timestamp = 2020-10-01T12:34:56Z
@@ -33,6 +35,7 @@ Description: "Example of a fatal-error Acknowledgement message."
 
 Instance: eada5e7a-a7ef-43b1-bfd6-024d5e64294c
 InstanceOf: MedComMessagingAcknowledgement
+Title: "ok Acknowledgement message"
 Description: "Example of a ok Acknowledgement message."
 * type = $BundleType#message
 * timestamp = 2021-01-01T12:34:56Z

diff --git a/input/fsh/MedComMessagingAcknowledgementHeader.fsh b/input/fsh/MedComMessagingAcknowledgementHeader.fsh
@@ -16,6 +16,7 @@ Alias: $AcknowledgementCode = http://hl7.org/fhir/ValueSet/Acknowledgement-code
 
 Instance: ff9055ec-b1f1-48b6-933a-063dff0a6faf
 InstanceOf: MedComMessagingAcknowledgementHeader
+Title: "Message header for an empty message. Valid only if used in a bundle (message)"
 Description: "Message header for an empty message. Valid only if used in a bundle (message)."
 * destination.extension[use] = b4e7e16b-9658-4172-acd7-5e7193f2cc5f
 * eventCoding = $MessageEvents#empty-message
@@ -28,6 +29,7 @@ Description: "Message header for an empty message. Valid only if used in a bundl
 
 Instance: 4879c81e-0607-4ccb-b358-24a72208e30d
 InstanceOf: MedComMessagingAcknowledgementHeader
+Title: "Message header for an fatal-error message"
 Description: "Message header for an fatal-error message"
 * destination.extension[use] = b4e7e16b-9658-4172-acd7-5e7193f2cc5f
 * eventCoding = $MessageEvents#empty-message
@@ -41,6 +43,7 @@ Description: "Message header for an fatal-error message"
 
 Instance: 4aa2d9bf-2c6c-47e8-bce4-7928bcd51019
 InstanceOf: MedComMessagingAcknowledgementHeader
+Title: "Message header for an ok message"
 Description: "Message header for an ok message"
 * destination.extension[use] = b4e7e16b-9658-4172-acd7-5e7193f2cc5f
 * eventCoding = $MessageEvents#empty-message
@@ -57,6 +60,7 @@ Alias: $CodeCode = http://hl7.org/fhir/ValueSet/issue-type
 
 Instance: 4ecb2a8e-3a68-4083-910e-811296affd43
 InstanceOf: OperationOutcome
+Title: "Example of a error operationOutcome"
 Description: "Example of a error operationOutcome"
 * issue.severity = $ServerityCode#error
 * issue.code =  $CodeCode#structure
@@ -65,6 +69,7 @@ Description: "Example of a error operationOutcome"
 
 Instance: e87bc9d4-f876-4b6f-8585-40b26dc1e369
 InstanceOf: OperationOutcome
+Title: "Example of a ok operationOutcome"
 Description: "Example of a ok operationOutcome"
 * issue.severity = $ServerityCode#information
 * issue.code =  $CodeCode#structure

diff --git a/input/fsh/MedComMessagingMessageHeader.fsh b/input/fsh/MedComMessagingMessageHeader.fsh
@@ -14,7 +14,7 @@ Description: "Message Header for MedCom message bundles"
 * destination ^slicing.discriminator.type = #value
 * destination ^slicing.discriminator.path = "$this.extension.value"
 * destination ^slicing.rules = #closed
-* destination contains primary 1..1 MS and cc 0.. MS
+* destination contains primary 1..1 MS and cc 0..
 * destination[primary].extension[use].valueCoding = $Use#primary
 * destination[primary].receiver only Reference(MedComMessagingOrganization)
 * destination[primary].receiver 1.. MS
@@ -44,6 +44,7 @@ Alias: $MessageEvents = http://medcomfhir.dk/fhir/core/1.0/CodeSystem/medcom-mes
 
 Instance: 3881874e-2042-4a00-aee8-23512799f512
 InstanceOf: MedComMessagingMessageHeader
+Title: "Message Header for an empty message. Valid only if used in a bundle (message)"
 Description: "Message Header for an empty message. Valid only if used in a bundle (message)."
 * destination.extension[use] = b4e7e16b-9658-4172-acd7-5e7193f2cc5f
 * eventCoding = $MessageEvents#empty-message

diff --git a/input/fsh/MedComMessagingOrganization.fsh b/input/fsh/MedComMessagingOrganization.fsh
@@ -13,13 +13,15 @@ Alias: $EANCode = urn:oid:1.3.88
 
 Instance: 74cdf292-abf3-4f5f-80ea-60a48013ff6d
 InstanceOf: MedComMessagingOrganization
+Title: "Example of an organization with a SOR and an EAN identifier."
 Description: "Example of an organization with a SOR and an EAN identifier."
 * identifier[sorIdentifier].value = "543210987654321"
 * identifier[eanIdentifier].value = "5790000121526"
 * name = "Receiver Organization"
 
 Instance: d7056980-a8b2-42aa-8a0e-c1fc85d1f40d
 InstanceOf: MedComMessagingOrganization
+Title: "Example of an organization with a SOR and an EAN identifier"
 Description: "Example of an organization with a SOR and an EAN identifier."
 * identifier[sorIdentifier].value = "123456789012345"
 * identifier[eanIdentifier].value = "5790001382445"

diff --git a/input/fsh/MedComMessagingProvenance.fsh b/input/fsh/MedComMessagingProvenance.fsh
@@ -34,6 +34,7 @@ Alias: $ActivityCode = http://medcomfhir.dk/fhir/core/1.0/CodeSystem/medcom-mess
 
 Instance: 4c284936-5454-4116-95fc-3c8eeeed2400
 InstanceOf: MedComMessagingProvenance
+Title: "Provenance information for a medcom message. Valid only if used in a bundle (message)"
 Description: "Provenance information for a medcom message. Valid only if used in a bundle (message)."
 * target = Reference(42cb9200-f421-4d08-8391-7d51a2503cb4)
 * occurredDateTime = 2020-09-28T12:34:56Z
@@ -45,6 +46,7 @@ Description: "Provenance information for a medcom message. Valid only if used in
 
 Instance: f18213f8-2e2c-458d-86ff-4e48ac5d7162
 InstanceOf: MedComMessagingProvenance
+Title: "Provenance information for a medcom message. Valid only if used in a bundle (message)"
 Description: "Provenance information for a medcom message. Valid only if used in a bundle (message)."
 Usage: #inline
 * target = Reference(b0d424f8-33a9-4cc2-a528-a6cc1c58727b)
@@ -55,6 +57,7 @@ Usage: #inline
 
 Instance: 30c0f779-783f-46b2-b38f-faebd2bedb3f
 InstanceOf: MedComMessagingProvenance
+Title: "Provenance information for a medcom message. Valid only if used in a bundle (message)"
 Description: "Provenance information for a medcom message. Valid only if used in a bundle (message)."
 Usage: #inline
 * target = Reference(b0d424f8-33a9-4cc2-a528-a6cc1c58727b)
@@ -67,6 +70,7 @@ Usage: #inline
 
 Instance: fdcf5a48-8264-48d5-8291-15f54b187b3e
 InstanceOf: MedComMessagingProvenance
+Title: "Provenance information for a medcom message. Valid only if used in a bundle (message)"
 Description: "Provenance information for a medcom message. Valid only if used in a bundle (message)."
 Usage: #inline
 * target = Reference(d5bd2111-2576-48d3-84d4-8be0297a038d)
@@ -77,6 +81,7 @@ Usage: #inline
 
 Instance: 7466d9f6-d3ae-4be5-8ed7-b333dad30205
 InstanceOf: MedComMessagingProvenance
+Title: "Provenance information for a medcom message. Valid only if used in a bundle (message)."
 Description: "Provenance information for a medcom message. Valid only if used in a bundle (message)."
 Usage: #inline
 * target = Reference(d5bd2111-2576-48d3-84d4-8be0297a038d)
@@ -89,6 +94,7 @@ Usage: #inline
 
 Instance: d7cf3888-6f42-4e4d-929c-d2475d24fba0
 InstanceOf: MedComMessagingProvenance
+Title: "Provenance information for a medcom Hospital Notification message. Valid only if used in a bundle (message) -admit"
 Description: "Provenance information for a medcom Hospital Notification message. Valid only if used in a bundle (message)."
 * target = Reference(51b27813-8aa8-4fa1-846b-aeabf5afb7d4)
 * occurredDateTime = 2020-10-15T13:44:14Z
@@ -100,6 +106,7 @@ Description: "Provenance information for a medcom Hospital Notification message.
 
 Instance: ccea231f-51c9-4eaa-a2f8-5a1e7d103574
 InstanceOf: MedComMessagingProvenance
+Title: "Provenance information for a medcom Hospital Notification message. Valid only if used in a bundle (message). -leave"
 Description: "Provenance information for a medcom Hospital Notification message. Valid only if used in a bundle (message)."
 Usage: #inline
 * target = Reference(b563a2b2-bf92-4b13-bbd2-0a021a95bded)
@@ -110,6 +117,7 @@ Usage: #inline
 
 Instance: dc421d0a-cded-470f-9a53-2ddba7583baa
 InstanceOf: MedComMessagingProvenance
+Title: "Provenance information for a medcom Hospital Notification message. Valid only if used in a bundle (message). - leave"
 Description: "Provenance information for a medcom Hospital Notification message. Valid only if used in a bundle (message)."
 * target = Reference(b563a2b2-bf92-4b13-bbd2-0a021a95bded)
 * occurredDateTime = 2020-10-20T10:21:56Z
@@ -123,6 +131,7 @@ Description: "Provenance information for a medcom Hospital Notification message.
 
 Instance: 04db4939-7c60-4ac6-aefc-523f809ccba6
 InstanceOf: MedComMessagingProvenance
+Title: "Provenance information for a medcom Hospital Notification message. Valid only if used in a bundle (message). - end leave"
 Description: "Provenance information for a medcom Hospital Notification message. Valid only if used in a bundle (message)."
 * target = Reference(e47254da-f170-46f0-b624-4778a9c92b1f)
 * occurredDateTime = 2020-10-25T09:12:34Z
@@ -134,6 +143,7 @@ Description: "Provenance information for a medcom Hospital Notification message.
 
 Instance: 1d70842e-1168-41a3-a409-45f63c10f4d2
 InstanceOf: MedComMessagingProvenance
+Title: "Provenance information for a medcom Hospital Notification message. Valid only if used in a bundle (message). - end leave"
 Description: "Provenance information for a medcom Hospital Notification message. Valid only if used in a bundle (message)."
 * target = Reference(e47254da-f170-46f0-b624-4778a9c92b1f)
 * occurredDateTime = 2020-10-20T10:21:56Z
@@ -145,6 +155,7 @@ Description: "Provenance information for a medcom Hospital Notification message.
 
 Instance: 0ffb42f5-d172-4df0-92c1-012f55667879
 InstanceOf: MedComMessagingProvenance
+Title: "Provenance information for a medcom Hospital Notification message. Valid only if used in a bundle (message). - end leave"
 Description: "Provenance information for a medcom Hospital Notification message. Valid only if used in a bundle (message)."
 Usage: #inline
 * target = Reference(e47254da-f170-46f0-b624-4778a9c92b1f)
@@ -157,6 +168,7 @@ Usage: #inline
 
 Instance: 491827bf-337e-4083-9ef0-101b38966179
 InstanceOf: MedComMessagingProvenance
+Title: "Provenance information for a medcom Hospital Notification message. Valid only if used in a bundle (message). - discharge"
 Description: "Provenance information for a medcom Hospital Notification message. Valid only if used in a bundle (message)."
 Usage: #inline
 * target = Reference(01affa53-c157-4080-abb0-8e681524f969)
@@ -167,6 +179,7 @@ Usage: #inline
 
 Instance: 2710698c-83eb-4c3e-81c8-fe8e40baf524
 InstanceOf: MedComMessagingProvenance
+Title: "Provenance information for a medcom Hospital Notification message. Valid only if used in a bundle (message). - discharge"
 Description: "Provenance information for a medcom Hospital Notification message. Valid only if used in a bundle (message)."
 Usage: #inline
 * target = Reference(01affa53-c157-4080-abb0-8e681524f969)
@@ -181,6 +194,7 @@ Usage: #inline
 //patient is admitted before deceased
 Instance: 3302eb96-a10a-47c3-95b6-461cb053cbd7
 InstanceOf: MedComMessagingProvenance
+Title: "patient is admitted before deceased"
 Description: "Provenance information for a medcom Hospital Notification message. Valid only if used in a bundle (message)."
 Usage: #inline
 * target = Reference(29b4818e-02de-4cc4-b418-d20cbc7b5404)
@@ -192,6 +206,7 @@ Usage: #inline
 //patient is deceased
 Instance: 09942adb-197a-4e30-bec8-566e3a113efe
 InstanceOf: MedComMessagingProvenance
+Title: "patient is deceased"
 Description: "Provenance information for a medcom Hospital Notification message when patient deceased. Valid only if used in a bundle (message)."
 Usage: #inline
 * target = Reference(8efc6d95-6161-4493-99c9-f359488dedb8)