Skip to content

Commit

Permalink
Examples and description of the standard are updated
Browse files Browse the repository at this point in the history
#19 - added description of the purpose of the standard
#18 - added description of the timestamps
#16 - added description of the CodeSystem and ValueSet
  • Loading branch information
tmsMedcom committed Oct 4, 2022
1 parent 818aae0 commit 53008d2
Show file tree
Hide file tree
Showing 18 changed files with 720 additions and 77 deletions.
29 changes: 20 additions & 9 deletions input/fsh/AcknowledgementProvenanceInstances.fsh
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,9 @@ Instance: 4c284936-5454-4116-95fc-3c8eeeed2400
InstanceOf: MedComMessagingProvenance
Title: "CareCommunication example. The Provenance instance is only valid if used in a bundle (message) - new message"
Description: "CareCommunication example. The Provenance instance is only valid if used in a bundle (message) - new message"
Usage: #inline
* target = Reference(42cb9200-f421-4d08-8391-7d51a2503cb4)
* occurredDateTime = 2020-09-28T12:34:56Z
* recorded = 2020-09-28T12:34:56Z
* occurredDateTime = 2022-09-01T12:01:20+02:00
* recorded = 2022-09-01T12:01:20Z
* activity.coding = $ActivityCode#new-message
* agent.who = Reference(d7056980-a8b2-42aa-8a0e-c1fc85d1f40d)

Expand All @@ -14,9 +13,9 @@ InstanceOf: MedComMessagingProvenance
Title: "Provenance information for an Acknowledgement message - CareCommunication. Valid only if used in a bundle (message)"
Description: "Provenance information for an Acknowledgementmessage - CareCommunication. Valid only if used in a bundle (message)."
* target = Reference(aba2d9bf-2c6c-47e8-bce4-7928bcd51019)
* occurredDateTime = 2020-09-28T12:34:57Z
* recorded = 2020-09-28T12:34:57Z
* activity.coding = $ActivityCode#acknowledgment
* occurredDateTime = 2022-09-01T12:01:20+02:00
* recorded = 2022-09-01T12:01:20Z
* activity.coding = $ActivityCode#acknowledgement
* agent.who = Reference(74cdf292-abf3-4f5f-80ea-60a48013ff6d)
* entity.role = #revision
* entity.what = Reference(42cb9200-f421-4d08-8391-7d51a2503cb4)
Expand All @@ -26,9 +25,21 @@ InstanceOf: MedComMessagingProvenance
Title: "Provenance information for an Acknowledgement message - CareCommunication. Valid only if used in a bundle (message)"
Description: "Provenance information for an Acknowledgementmessage - CareCommunication. Valid only if used in a bundle (message)."
* target = Reference(b879c81e-0607-4ccb-b358-24a72208e30d)
* occurredDateTime = 2020-09-28T12:34:57Z
* recorded = 2020-09-28T12:34:57Z
* activity.coding = $ActivityCode#acknowledgment
* occurredDateTime = 2022-09-01T12:01:20+02:00
* recorded = 2022-09-01T12:01:20Z
* activity.coding = $ActivityCode#acknowledgement
* agent.who = Reference(74cdf292-abf3-4f5f-80ea-60a48013ff6d)
* entity.role = #revision
* entity.what = Reference(42cb9200-f421-4d08-8391-7d51a2503cb4)

Instance: 9b56aa88-9745-12ec-b919-0242ac122002
InstanceOf: MedComMessagingProvenance
Title: "Provenance information for an Acknowledgement message - CareCommunication. Valid only if used in a bundle (message)"
Description: "Provenance information for an Acknowledgementmessage - CareCommunication. Valid only if used in a bundle (message)."
* target = Reference(c9a0b728-0807-11ed-861d-0242ac120002)
* occurredDateTime = 2022-09-01T12:01:20+02:00
* recorded = 2022-09-01T12:01:20Z
* activity.coding = $ActivityCode#acknowledgement
* agent.who = Reference(74cdf292-abf3-4f5f-80ea-60a48013ff6d)
* entity.role = #revision
* entity.what = Reference(42cb9200-f421-4d08-8391-7d51a2503cb4)
41 changes: 12 additions & 29 deletions input/fsh/GeneralInstances.fsh
Original file line number Diff line number Diff line change
@@ -1,20 +1,12 @@
// deceased MedComCorePatient
Instance: 382fb8a3-6725-41e2-a615-2b1cfcfe9931
InstanceOf: MedComCorePatient
Title: "Erik Clausen"
Description: "Patient deceased with a managing organization. Valid only if used in a bundle (message)."
Title: "Bruno Test Elmer"
Description: "Patient described with minimal information. Valid only if used in a Bundle."
* identifier[cpr].system = "urn:oid:1.2.208.176.1.2"
* identifier[cpr].value = "0101010141"
* identifier[cpr].value = "2509479989"
* name[official].use = #official
* name[official].given = "Erik"
* name[official].family = "Clausen"
* telecom.system = #phone
* telecom.value = "24533421"
* telecom.use = #home
* address.line = "Forskerparken 10"
* address.city = "Odense M"
* address.postalCode = "5230"
* deceasedBoolean = true
* name[official].family = "Elmer"

// MedComMessagingMessage instance

Expand Down Expand Up @@ -45,10 +37,10 @@ Title: "Message Header for an empty message. Valid only if used in a bundle (mes
Description: "Message Header for an empty message. Valid only if used in a bundle (message)."
* destination[primary].extension[use] = b4e7e16b-9658-4172-acd7-5e7193f2cc5f
* eventCoding = $MessageEvents#empty-message
* destination[primary].endpoint = "http://medcomfhir.dk/unknown"
* destination[primary].endpoint = "https://sor2.sum.dsdn.dk/#id=953741000016009"
* destination[primary].receiver = Reference(74cdf292-abf3-4f5f-80ea-60a48013ff6d)
* sender = Reference(d7056980-a8b2-42aa-8a0e-c1fc85d1f40d)
* source.endpoint = "http://medcomfhir.dk/unknown"
* source.endpoint = "https://sor2.sum.dsdn.dk/#id=265161000016000"

// CareCommunication example
Instance: 42cb9200-f421-4d08-8391-7d51a2503cb4
Expand All @@ -57,10 +49,10 @@ Title: "Message header for care communication message. Valid only if used in a b
Description: "Message header for care communication message. Valid only if used in a bundle (message)."
* destination[primary].extension[use] = b4e7e16b-9658-4172-acd7-5e7193f2cc5f
* eventCoding = $MessageEvents#care-communication-message
* destination[primary].endpoint = "http://medcomfhir.dk/unknown"
* destination[primary].endpoint = "https://sor2.sum.dsdn.dk/#id=265161000016000"
* destination[primary].receiver = Reference(74cdf292-abf3-4f5f-80ea-60a48013ff6d)
* sender = Reference(d7056980-a8b2-42aa-8a0e-c1fc85d1f40d)
* source.endpoint = "http://medcomfhir.dk/unknown"
* source.endpoint = "https://sor2.sum.dsdn.dk/#id=953741000016009"

//MedComMessagingOrganization instances (sender, receiver, serviceprovider)

Expand All @@ -69,24 +61,15 @@ Instance: 74cdf292-abf3-4f5f-80ea-60a48013ff6d
InstanceOf: MedComMessagingOrganization
Title: "Example of a reciever organization with a SOR and an EAN identifier."
Description: "Example of an organization with a SOR and an EAN identifier."
* identifier[SOR-ID].value = "543210987654321"
* identifier[EAN-ID].value = "5790000121526"
* identifier[SOR-ID].value = "265161000016000"
* identifier[EAN-ID].value = "5790000209354"
* name = "Receiver Organization"

// Sender instance
Instance: d7056980-a8b2-42aa-8a0e-c1fc85d1f40d
InstanceOf: MedComMessagingOrganization
Title: "Example of a sender organization with a SOR and an EAN identifier."
Description: "Example of an organization with a SOR and an EAN identifier."
* identifier[SOR-ID].value = "123456789012345"
* identifier[EAN-ID].value = "5790001382445"
* identifier[SOR-ID].value = "953741000016009"
* identifier[EAN-ID].value = "5790001348120"
* name = "Sender Organization"

// Service provider instance
Instance: bf839e87-4e44-4977-b38e-92b5a6f187b5
InstanceOf: MedComMessagingOrganization
Title: "Example of a service provider organization with a SOR and an EAN identifier."
Description: "Example of an organization with a SOR and an EAN identifier."
* identifier[SOR-ID].value = "325421000016001"
* identifier[EAN-ID].value = "5798002472264"

15 changes: 6 additions & 9 deletions input/fsh/MedComAcknowledgementMessage.fsh
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Expression: "iif(entry.resource.ofType(MessageHeader).response.code = 'ok', true
Invariant: medcom-messaging-3
Description: "The message header shall conform to medcom-messaging-acknowledgementHeader profile"
Severity: #error
Expression: "entry.ofType(MessageHeader).all(resource.conformsTo('http://medcomfhir.dk/fhir/core/1.0/StructureDefinition/medcom-messaging-acknowledgementHeader'))"
Expression: "entry.ofType(MessageHeader).all(resource.conformsTo('http://medcomfhir.dk/fhir/acknowledgement/StructureDefinition/medcom-messaging-acknowledgementHeader'))"

Invariant: medcom-messaging-4
Description: "The Acknowledgement entry shall contain at least one Provenance resource"
Expand All @@ -26,9 +26,8 @@ Instance: a8c041b8-c65a-4fde-a90f-962076918834
InstanceOf: MedComAcknowledgementMessage
Title: "Example Acknowledgement message - Ok"
Description: "Example Acknowledgement message - Ok"
Usage: #example
* type = $BundleType#message
* timestamp = 2021-01-01T12:34:56Z
* timestamp = 2022-09-01T12:01:00Z
* entry[+].fullUrl = "MessageHeader/aba2d9bf-2c6c-47e8-bce4-7928bcd51019"
* entry[=].resource = aba2d9bf-2c6c-47e8-bce4-7928bcd51019
* entry[+].fullUrl = "Provenance/4c284936-5454-4116-95fc-3c8eeeed2400"
Expand All @@ -44,9 +43,8 @@ Instance: bc9535ef-ed94-4060-a928-7baddec7ee71
InstanceOf: MedComAcknowledgementMessage
Title: "Example Acknowledgement message - Fatal error"
Description: "Example Acknowledgement message - Fatal error"
Usage: #example
* type = $BundleType#message
* timestamp = 2020-10-01T12:34:56Z
* timestamp = 2022-09-01T12:01:00Z
* entry[+].fullUrl = "MessageHeader/b879c81e-0607-4ccb-b358-24a72208e30d"
* entry[=].resource = b879c81e-0607-4ccb-b358-24a72208e30d
* entry[+].fullUrl = "Provenance/4c284936-5454-4116-95fc-3c8eeeed2400"
Expand All @@ -65,15 +63,14 @@ Instance: c9c2b2f6-0807-11ed-861d-0242ac120002
InstanceOf: MedComAcknowledgementMessage
Title: "Example Acknowledgement message - Transient error"
Description: "Example Acknowledgement message - Transient error"
Usage: #example
* type = $BundleType#message
* timestamp = 2020-10-01T12:34:56Z
* timestamp = 2022-09-01T12:01:00Z
* entry[+].fullUrl = "MessageHeader/c9a0b728-0807-11ed-861d-0242ac120002"
* entry[=].resource = c9a0b728-0807-11ed-861d-0242ac120002
* entry[+].fullUrl = "Provenance/4c284936-5454-4116-95fc-3c8eeeed2400"
* entry[=].resource = 4c284936-5454-4116-95fc-3c8eeeed2400
* entry[+].fullUrl = "Provenance/9c56ba88-9645-11ec-b909-0242ac120002"
* entry[=].resource = 9c56ba88-9645-11ec-b909-0242ac120002
* entry[+].fullUrl = "Provenance/9b56aa88-9745-12ec-b919-0242ac122002"
* entry[=].resource = 9b56aa88-9745-12ec-b919-0242ac122002
* entry[+].fullUrl = "Organization/d7056980-a8b2-42aa-8a0e-c1fc85d1f40d"
* entry[=].resource = d7056980-a8b2-42aa-8a0e-c1fc85d1f40d
* entry[+].fullUrl = "Organization/74cdf292-abf3-4f5f-80ea-60a48013ff6d"
Expand Down
27 changes: 13 additions & 14 deletions input/fsh/MedComAcknowledgementMessageHeader.fsh
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,11 @@ Title: "Acknowledgement MessageHeader - empty message"
Description: "Acknowledgement MessageHeader - empty message. Valid only if used in a Bundle (message)."
Usage: #inline
* destination[primary].extension[use] = b4e7e16b-9658-4172-acd7-5e7193f2cc5f
* eventCoding = $MessageEvents#acknowledgment-message
* destination[primary].endpoint = "http://medcom.dk/unknown"
* eventCoding = $MessageEvents#acknowledgement-message
* destination[primary].endpoint = "https://sor2.sum.dsdn.dk/#id=265161000016000"
* destination[primary].receiver = Reference(74cdf292-abf3-4f5f-80ea-60a48013ff6d)
* sender = Reference(d7056980-a8b2-42aa-8a0e-c1fc85d1f40d)
* source.endpoint = "http://medcom.dk/unknown"
* source.endpoint = "https://sor2.sum.dsdn.dk/#id=953741000016009"
* response.identifier = "eb26be85-fdb7-454d-a980-95cba6d1745b"
* response.code = $AcknowledgementCode#fatal-error

Expand All @@ -30,11 +30,11 @@ Title: "Acknowledgement MessageHeader - fatal-error message"
Description: "Acknowledgement MessageHeader - fatal-error message. Valid only if used in a Bundle (message)."
Usage: #example
* destination[primary].extension[use] = b4e7e16b-9658-4172-acd7-5e7193f2cc5f
* eventCoding = $MessageEvents#acknowledgment-message
* destination[primary].endpoint = "http://medcomfhir.dk/unknown"
* eventCoding = $MessageEvents#acknowledgement-message
* destination[primary].endpoint = "https://sor2.sum.dsdn.dk/#id=265161000016000"
* destination[primary].receiver = Reference(74cdf292-abf3-4f5f-80ea-60a48013ff6d)
* sender = Reference(d7056980-a8b2-42aa-8a0e-c1fc85d1f40d)
* source.endpoint = "http://medcomfhir.dk/unknown"
* source.endpoint = "https://sor2.sum.dsdn.dk/#id=953741000016009"
* response.identifier = "53128d9b-cede-4c7f-8904-809eab322d7d"
* response.code = $AcknowledgementCode#fatal-error
* response.details = Reference(becb2a8e-3a68-4083-910e-811296affd43)
Expand All @@ -45,12 +45,12 @@ Title: "Acknowledgement MessageHeader - ok message"
Description: "Acknowledgement MessageHeader - ok message. Valid only if used in a Bundle (message)."
Usage: #example
* destination[primary].extension[use] = b4e7e16b-9658-4172-acd7-5e7193f2cc5f
* eventCoding = $MessageEvents#acknowledgment-message
* destination[primary].endpoint = "http://medcomfhir.dk/unknown"
* eventCoding = $MessageEvents#acknowledgement-message
* destination[primary].endpoint = "https://sor2.sum.dsdn.dk/#id=265161000016000"
* destination[primary].receiver = Reference(74cdf292-abf3-4f5f-80ea-60a48013ff6d)
* sender = Reference(d7056980-a8b2-42aa-8a0e-c1fc85d1f40d)
* source.endpoint = "http://medcomfhir.dk/unknown"
* response.identifier = "382fb8a3-6725-41e2-a615-2b1cfcfe9931"
* source.endpoint = "https://sor2.sum.dsdn.dk/#id=953741000016009"
* response.identifier = "42cb9200-f421-4d08-8391-7d51a2503cb4"
* response.code = $AcknowledgementCode#ok

Instance: c9a0b728-0807-11ed-861d-0242ac120002
Expand All @@ -59,12 +59,11 @@ Title: "Acknowledgement MessageHeader - transient-error message"
Description: "Acknowledgement MessageHeader - transient-error message. Valid only if used in a Bundle (message)."
Usage: #example
* destination[primary].extension[use] = b4e7e16b-9658-4172-acd7-5e7193f2cc5f
* eventCoding = $MessageEvents#acknowledgment-message
* destination[primary].endpoint = "http://medcomfhir.dk/unknown"
* eventCoding = $MessageEvents#acknowledgement-message
* destination[primary].endpoint = "https://sor2.sum.dsdn.dk/#id=265161000016000"
* destination[primary].receiver = Reference(74cdf292-abf3-4f5f-80ea-60a48013ff6d)
* sender = Reference(d7056980-a8b2-42aa-8a0e-c1fc85d1f40d)
* source.endpoint = "http://medcomfhir.dk/unknown"
* source.endpoint = "https://sor2.sum.dsdn.dk/#id=953741000016009"
* response.identifier = "53128d9b-cede-4c7f-8904-809eab322d7d"
* response.code = $AcknowledgementCode#transient-error
* response.details = Reference(c0055484-2a56-4da2-81b8-a9d5087d865c)

6 changes: 3 additions & 3 deletions input/fsh/MedComAcknowledgementOperationOutcome.fsh
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Description: "Example of an error operationOutcome. Valid only if used in a Bund
Usage: #example
* issue.severity = $ServerityCode#error
* issue.code = $CodeCode#structure
* issue.details.coding = $IssueCodes#testing-error
* issue.details.coding = $IssueCodes#message-development-error

Instance: a87bc9d4-f876-4b6f-8585-40b26dc1e369
InstanceOf: MedComAcknowledgementOperationOutcome
Expand All @@ -27,7 +27,7 @@ Description: "Example of an error operationOutcome. Valid only if used in a Bund
Usage: #example
* issue.severity = $ServerityCode#information
* issue.code = $CodeCode#informational
* issue.details.coding = $IssueCodes#testing-error
* issue.details.coding = $IssueCodes#message-development-error


Instance: c0055484-2a56-4da2-81b8-a9d5087d865c
Expand All @@ -37,6 +37,6 @@ Description: "Example of an error operationOutcome. Valid only if used in a Bund
Usage: #example
* issue.severity = $ServerityCode#error
* issue.code = $CodeCode#value
* issue.details.coding = $IssueCodes#testing-error
* issue.details.coding = $IssueCodes#message-development-error


Loading

0 comments on commit 53008d2

Please sign in to comment.