Skip to content

Commit

Permalink
Layout updates for v. 3.0.0
Browse files Browse the repository at this point in the history
  • Loading branch information
@tmsMedcom
tmsMedcom committed Jan 6, 2023
1 parent 7ce6a8a commit 91ad4b1
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 14 deletions.
25 changes: 14 additions & 11 deletions docs/assets/documents/Intro-Technical-Spec-ENG.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,9 @@
* [3.1 STIN - Start hospital stay - admitted](#31-stin---start-hospital-stay---admitted)
* [3.2 STOR - Start leave](#32-stor---start-leave)
* [3.3 SLOR - End leave](#33-slor---end-leave)
* [3.4 SLHJ - End hospital stay - patient completed to home/primary sector](#34-slhj---end-hospital-stay---patient-completed-to-home-primary-sector)
* [3.4 SLHJ - End hospital stay - patient completed to home/primary sector](#slhj)
* [3.5 MORS - Deceased](#35-mors---deceased)
* [3.6 AN_STIN - Cancellation Start hospital stay - admitted](#36-an-stin---cancellation-start-hospital-stay---admitted)
* [3.6 AN_STIN - Cancellation Start hospital stay - admitted](#anstin)
* [4 Timestamps in HospitalNotification message](#4-timestamps-in-hospitalnotification-message)

>Note: In case of discrepancies between the <a href="https://medcomfhir.dk/ig/hospitalnotification/" target="_blank">MedCom HospitalNotification Implementation Guide (IG)</a> and this page, it is the IG which should be followed. Please contact <[email protected]> if you find discrepancies.
Expand Down Expand Up @@ -124,30 +124,33 @@ MedComMessagingProvenance is used to keep track of the messaging history and def


## 3 Examples in a HospitalNotification Message
Examples in section [3.1](#31-stin---start-hospital-stay---admitted) to [3.6](#36-an_stin---cancellation-start-hospital-stay---admitted) illustrates different types of HospitalNotifications. For each example, the type of HospitalNotification can be seen in the associated headline. In the examples the serviceProvider and sender organisation is represented by the same Organization instance. Further, the instances of resources are in the same order to create a better overview, however IT vendors cannot assume any specific order of the instances in a message.
Examples in section [3.1](#31-stin---start-hospital-stay---admitted) to [3.6](#36-an_stin---cancellation-start-hospital-stay---admitted) illustrates different types of HospitalNotifications. For each example, the type of HospitalNotification can be seen in the associated headline. In the examples the serviceProvider and sender organisation is represented by the same Organization instance. Further, the instances in the examples are in the same order to create a better overview, however IT vendors cannot assume any specific order of the instances in a message.

<a href="https://medcomdk.github.io/dk-medcom-hospitalnotification/#14-hospitalnotification-codes" target="_blank">Click here to get an overview of the HospitalNotification types.</a>


On <a href="#Fig2" rel="noopener noreferrer">Figure 2</a> to <a href="#Fig7" rel="noopener noreferrer">Figure 7</a>, the required content of a HospitalNotification message is illustrated.
There is a difference between the required elements and MustSupport elements, as the required elements always shall be included in a message. However, MustSupport elements must be included if they are present in the sender's system and the receiver must be able to handle the information if it is included.

<a href="https://medcomfhir.dk/ig/hospitalnotification/StructureDefinition-medcom-hospitalNotification-message-examples.html" target="_blank">Click here to see examples in in XML and JSON for MedCom HospitalNotificationMessage </a>


On <a href="#Fig2" rel="noopener noreferrer">Figure 2</a>, only one instance of the Provenance recource is included, since only one HospitalNotification has been sent. On <a href="#Fig3" rel="noopener noreferrer">Figure 3</a> to <a href="#Fig7" rel="noopener noreferrer">Figure 7</a>, two or more in instance of the Provenance recource, to reference the previously sent HospitalNotifications as well as the instance representing the current HospitalNotfication.


### 3.1 STIN - Start hospital stay - admitted
On <a href="#Fig2" rel="noopener noreferrer">Figure 2</a>, a simplified example of a ‘Start hospital stay - admitted’ HospitalNotification is presented. In the MessageHeader there is a request for a reportOfAdmission (extension:reportOfAdmissionFlag). In the Encounter instance the status is ‘in-progress’, and the Encounter is populated with a start timestamp (period.start). In the Provenance instance the activity code is ‘admit-inpatient’.

<figure>
<img src="../images/HNAdmitInPat.svg" alt="Simplified example: STIN - Start hospital stay - admitted" style="width: 55%" id="Fig2">
<img src="../images/HNAdmitInPat.svg" alt="Simplified example: STIN - Start hospital stay - admitted" style="width: 48%" id="Fig2">
<figcaption text-align = "center"><b>Figure 2: Simplified example: Start hospital stay - admitted</b></figcaption>
</figure>

### 3.2 STOR - Start leave
On <a href="#Fig3" rel="noopener noreferrer">Figure 3</a>, a simplified example of a ‘Start leave’ HospitalNotification is presented, which is sent in continuation of the simplified example in <a href="#Fig2" rel="noopener noreferrer">Figure 2</a>. The status in the Encounter is changed from ‘in-progress’ to ‘onleave’, and the Encounter is populated with a start timestamp for the period of leave (extension:leavePeriod.start). In the current Provenance instance the activity code is ‘start-leave-inpatient’.

<figure>
<img src="../images/HNstartOnleave.svg" alt="Simplified example: STOR - Start leave" style="width: 55%" id="Fig3">
<img src="../images/HNstartOnleave.svg" alt="Simplified example: STOR - Start leave" style="width: 48%" id="Fig3">
<figcaption text-align = "center"><b>Figure 3: Simplified example: Start leave</b></figcaption>
</figure>
<br><br>
Expand All @@ -156,16 +159,16 @@ On <a href="#Fig3" rel="noopener noreferrer">Figure 3</a>, a simplified example
On <a href="#Fig4" rel="noopener noreferrer">Figure 4</a>, a simplified example of a ‘End leave’ HospitalNotification is presented, which is sent in continuation of the simplified example in <a href="#Fig3" rel="noopener noreferrer">Figure 3</a>. The status in the Encounter is changed from ‘onleave’ to ‘in-progress’, and the Encounter is populated with a end timestamp for the period of leave (extension:leavePeriod.end). In the current Provenance instance the activity code is ‘end-leave-inpatient’.

<figure>
<img src="../images/HNendOnleave.svg" alt="Simplified example: SLOR - End leave" style="width: 55%" id="Fig4">
<img src="../images/HNendOnleave.svg" alt="Simplified example: SLOR - End leave" style="width: 48%" id="Fig4">
<figcaption text-align = "center"><b>Figure 4: Simplified example: End Leave</b></figcaption>
</figure>
<br><br>

### 3.4 SLHJ - End hospital stay - patient completed to home/primary sector
### 3.4 SLHJ - End hospital stay - patient completed to home/primary sector {#slhj}
On <a href="#Fig5" rel="noopener noreferrer">Figure 5</a>, a simplified example of a ‘End hospital stay - patient completed to home/primary sector’ HospitalNotification is presented, which is sent in continuation of the simplified example in <a href="#Fig2" rel="noopener noreferrer">Figure 2</a>. The status in the Encounter is changed from ‘in-progress’ to ‘finished’, and the Encounter is populated with a timestamp indicating end of the encounter (period.end). In the current Provenance instance the activity code is ‘discharge-inpatient-home’.

<figure>
<img src="../images/HNdischargeInPat.svg" alt="Simplified example: SLHJ - End hospital stay - patient completed to home/primary sector" style="width: 55%" id="Fig5">
<img src="../images/HNdischargeInPat.svg" alt="Simplified example: SLHJ - End hospital stay - patient completed to home/primary sector" style="width: 48%" id="Fig5">
<figcaption text-align = "center"><b>Figure 5: Simplified example: End hospital stay - patient completed to home/primary sector</b></figcaption>
</figure>
<br><br>
Expand All @@ -174,16 +177,16 @@ On <a href="#Fig5" rel="noopener noreferrer">Figure 5</a>, a simplified example
On <a href="#Fig6" rel="noopener noreferrer">Figure 6</a>, a simplified example of a ‘Deceased’ HospitalNotification is presented, which is sent in continuation of the simplified example in <a href="#Fig2" rel="noopener noreferrer">Figure 2</a>. The status in the Encounter is changed from ‘in-progress’ to ‘finished’, and the Encounter is populated with a timestamp indicating end of the encounter (period.end) i.e. the death of the patient. The element Patient.deceased is sat to ‘true’, indicating that the patient is deceased. In the current Provenance instance the activity code is ‘admit-inpatient’, as it shall remain the current activity.

<figure>
<img src="../images/HNdeceasedInPat.svg" alt="Simplified example: MORS - Deceased" style="width: 55%" id="Fig6">
<img src="../images/HNdeceasedInPat.svg" alt="Simplified example: MORS - Deceased" style="width: 48%" id="Fig6">
<figcaption text-align = "center"><b>Figure 6: Simplified example: Deceased</b></figcaption>
</figure>
<br><br>

### 3.6 AN_STIN - Cancellation Start hospital stay - admitted
### 3.6 AN_STIN - Cancellation Start hospital stay - admitted {#anstin}
On <a href="#Fig7" rel="noopener noreferrer">Figure 7</a>, a simplified example of a 'Cancellation Start hospital stay - admitted' HospitalNotification is presented, which is sent in continuation of the simplified example in <a href="#Fig2" rel="noopener noreferrer">Figure 2</a>. In the current Provenance instance the activity code is changed to ‘cancel-admit-inpatient’ and the entity.what is ‘removal’ indicating that the previous message is cancelled.

<figure>
<img src="../images/HNcancelEnteredInError.svg" alt="Simplified example: AN_STIN - Cancellation Start hospital stay - admitted" style="width: 55%" id="Fig7">
<img src="../images/HNcancelEnteredInError.svg" alt="Simplified example: AN_STIN - Cancellation Start hospital stay - admitted" style="width: 48%" id="Fig7">
<figcaption text-align = "center"><b>Figure 7: Simplified example: Cancellation Start hospital stay - admitted</b></figcaption>
</figure>
<br><br>
Expand Down
7 changes: 4 additions & 3 deletions docs/index.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -45,9 +45,10 @@ The use cases for HospitalNotification are qualified in collaboration with EPR-
<!-- <b>The use cases are currently in preparation. As soon as they are ready, they will be presented below in Danish and English:</b> -->

[Danish: Use cases](Advisomsygehusophold_use_cases__2.0.1.pdf)
> Please be aware that the Use cases are in danish.


> Please be aware that the use cases are in danish. Use cases in English, are currently in preparation. As soon as they are ready, they will be published.

<!-- Below, you can find the use cases in Danish and English be found:<br>
[Danish: Use cases](assets/documents/UseCases-DA.md) <br>
Expand Down Expand Up @@ -88,13 +89,13 @@ Mapping from previous OIOXML standards to the FHIR HospitalNotification standard

## 2 Test and certification

Certification of a system implies both an approved testprotocol and run-through of TouchStone test scripts. TouchStone describes an infrastructure that allows for automated test and validation against the IG's developed by MedCom. Test protocols and test scripts are used to test and certify whether systems comply to the HospitalNotification standard.
Certification of a system implies both an approved test protocol and run-through of TouchStone test scripts. TouchStone describes an infrastructure that allows for automated test and validation against the IG's developed by MedCom. Test protocols and test scripts are used to test and certify whether systems comply to the HospitalNotification standard.
<br>

<a href="https://medcomdk.github.io/MedComLandingPage/#3-test-and-certification">Click here to find the description of test and certification of FHIR standards in MedCom. </a>
<br>

> Note: Use cases for HospitalNotification in English, are currently in preparation. As soon as they are, ready they will be published.
> Note: Test protocols, for HospitalNotification in English, are currently in preparation. As soon as they are ready, they will be published.
**Sending a HospitalNotification message**
* [Test protocol](FHIR-advis_afsend_testprotokol.docx)
Expand Down

0 comments on commit 91ad4b1

Please sign in to comment.