MedMij:V2019.01 FHIR Images: verschil tussen versies
k (Beveiligde "MedMij:V2019.01 FHIR Images": Protect production page from accidental edits ([Bewerken=Alleen beheerders toestaan] (vervalt niet) [Hernoemen=Alleen beheerders toestaan] (vervalt niet))) |
|||
| (27 tussenliggende versies door 10 gebruikers niet weergegeven) | |||
| Regel 1: | Regel 1: | ||
| − | {{ | + | {{MedMij:V2019.01_Beelden1_Uitgefaseerd}} |
| − | + | __NUMBEREDHEADINGS__ | |
| − | {{ | + | {{DISPLAYTITLE:MedMij FHIR Implementation Guide: Images {{VersieInfo|Beelden|release=V2019.01}}}} |
| − | |||
| − | |||
[[Bestand:MedMij2.png |link=https://www.medmij.nl/|rechts|Naar medmij.nl]] | [[Bestand:MedMij2.png |link=https://www.medmij.nl/|rechts|Naar medmij.nl]] | ||
| Regel 19: | Regel 17: | ||
[[Bestand:Functioneel-02.png|link=MedMij:V2019.01_Ontwerpen |100px|rechts|Functional design|Go to functional design]] | [[Bestand:Functioneel-02.png|link=MedMij:V2019.01_Ontwerpen |100px|rechts|Functional design|Go to functional design]] | ||
| − | This page describes the exchange of images within MedMij. | + | This page describes the exchange of images within MedMij. Contrary to other MedMij use cases, we have not identified an existing information standard nor any specifically applicable HCIM<sup style="font-weight: bold;" title="Health and Care Information Model or Zorginformatiebouwstenen (zibs)">?</sup> models. To achieve exchange of images, MedMij adopts as much as possible from existing standards, such as the DICOM standard and the [http://wiki.ihe.net/index.php/Mobile_access_to_Health_Documents_(MHD) Mobile access to Health Documents (MHD) profile] from Integrating the Healthcare Enterprise (IHE) that defines a RESTful/HTTP interface to an [http://wiki.ihe.net/index.php/Cross-Enterprise_Document_Sharing XDS] environment using HL7 FHIR STU3 resources. |
| − | |||
| − | |||
| − | ''' | + | {{NoteBox|This specification builds off IHE MHD which usually serves as an IHE XDS compatible frontend. However having an XDS network on either sending or receiving side is '''not''' a requirement per this specification.}} |
| − | + | The specification currently consists of one use case, that covers sending an image by a patient to a healthcare provider. We anticipate adding a use case to retrieve images by the patient in a future version of this specification. This will most likely will be based on DICOMweb™, which is the DICOM standard for web-based medical imaging based on RESTful services. | |
| − | |||
| − | ''' | + | '''Note''': this page is part of the [https://informatiestandaarden.nictiz.nl/wiki/MedMij:V2019.01_FHIR_IG MedMij FHIR Implementation Guide] and is a technical representation of its [[MedMij:V2019.01_Ontwerpen|functional design]]. |
| − | [ | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | [ | ||
=Actors and transactions involved= | =Actors and transactions involved= | ||
| − | Table 1 shows the relevant actors, systems and FHIR capability statements in a MedMij context. The capability statements demonstrate the minimum requirements to be | + | Table 1 shows the relevant actors, systems and FHIR capability statements in a MedMij context. The capability statements demonstrate the minimum requirements to be in conformance with the described use cases. |
{| class="wikitable" | {| class="wikitable" | ||
| Regel 56: | Regel 44: | ||
| PHR | | PHR | ||
| Personal health record | | Personal health record | ||
| − | |[[Bestand: Verwijzing.png| 20px]] | + | |[[Bestand: Verwijzing.png| 20px]] {{Simplifier|http://nictiz.nl/fhir/CapabilityStatement/images-clientcapabilities|nictiz.fhir.nl.stu3.zib2017|pkgVersion=1.3.12|title=CapabilityStatement: Client}} |
| Image FHIR Client requirements | | Image FHIR Client requirements | ||
|- | |- | ||
| Regel 63: | Regel 51: | ||
| XIS | | XIS | ||
| Healthcare information system | | Healthcare information system | ||
| − | |[[Bestand: Verwijzing.png| 20px]] | + | |[[Bestand: Verwijzing.png| 20px]] {{Simplifier|http://nictiz.nl/fhir/CapabilityStatement/images-servercapabilities|nictiz.fhir.nl.stu3.zib2017|pkgVersion=1.3.12|title=CapabilityStatement: Server}} |
| Image FHIR Server requirements | | Image FHIR Server requirements | ||
|} | |} | ||
<font size = "1">'''Table 1. Actors, systems and FHIR capability statements'''</font> | <font size = "1">'''Table 1. Actors, systems and FHIR capability statements'''</font> | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
=Boundaries and Relationships= | =Boundaries and Relationships= | ||
| − | The use case where an image is sent from a PHR to a XIS is influenced by the IHE MHD profile with regards to the PHR message semantics and mandatory elements. The | + | The use case where an image is sent from a PHR to a XIS is influenced by the IHE MHD profile with regards to the PHR message semantics and mandatory elements. The main deviation of these use-case specifications is the use of the FHIR Media resource instead of the DocumentReference resource. Although the DocumentReference is in line with the requirements of persisting content in an XDS network and the DocumentReference can handle images, the Media resource is more appropriate and specific for the exchange of images. The Media resource has additional, relevant, (medical related) elements compared to the DocumentReference. These are the Media elements view, reasonCode, bodySite, device and to a lesser extent the height and width elements. In addition, the Media resource has a reference coming from the DiagnosticReport that may be of value for further development of the MedMij information standard for images. |
| − | A XIS can possibly act within a XDS network. | + | A XIS can possibly act within a XDS network. MedMij information standards have the primary objective to enable standardized communication between the parties that act within MedMij. As a secondary objective, exchange with parties that are part of a XDS networks are taken into account. For this objective, the PHR will need to provide additional meta information to the Media resource. The additional meta information allows XIS actors to index an image properly within a XDS network. The XIS is responsible for converting the PHR message into a XDS DocumentEntry. A mapping from the Media resource to the mandatory metadata elements of the IHE MHD DocumentReference resource is provided. The IHE MHD and general IHE XDS profiles will provide the information needed to produce a successful DocumentEntry for an image. |
=Use case: send image from a PHR to a XIS= | =Use case: send image from a PHR to a XIS= | ||
[[Bestand:Afsprakenstelsel-01.png|link=https://www.medmij.nl/afsprakenstelsel/|rechts |100px|Go to Afsprakenstelsel]] | [[Bestand:Afsprakenstelsel-01.png|link=https://www.medmij.nl/afsprakenstelsel/|rechts |100px|Go to Afsprakenstelsel]] | ||
| + | {{FHIR-IG-Afsprakenstelsel-Note}} | ||
== Introduction == | == Introduction == | ||
This use case describes the minimal required technical functionalities in order to exchange an image made by the patient to a healthcare provider. Typical process flow would be: | This use case describes the minimal required technical functionalities in order to exchange an image made by the patient to a healthcare provider. Typical process flow would be: | ||
| − | # Patients | + | # Patients creates, downloads or receives an image and uploads it to his PHR. |
# The PHR sends the image to the chosen XIS system. | # The PHR sends the image to the chosen XIS system. | ||
| − | # | + | #* Potentially the patient needs to provide sufficient metadata concerning the image. |
# A healthcare provider views the image in his XIS. | # A healthcare provider views the image in his XIS. | ||
This use case presumes made agreements between the patient and healthcare provider. Besides a technical answer by the XIS of the healthcare provider, no answer to the patient is expected. | This use case presumes made agreements between the patient and healthcare provider. Besides a technical answer by the XIS of the healthcare provider, no answer to the patient is expected. | ||
| − | The following technical specifications will concern the process mentioned | + | The following technical specifications will concern the process mentioned in bullet 2. |
==Actors== | ==Actors== | ||
| Regel 125: | Regel 93: | ||
== Invocations == | == Invocations == | ||
| − | |||
| − | |||
=== Client - PHR request=== | === Client - PHR request=== | ||
When the patient (PHR) wants to send one or more images, it issues a send image bundle request message. | When the patient (PHR) wants to send one or more images, it issues a send image bundle request message. | ||
| − | The PHR | + | The PHR initiates a FHIR transaction using a create action by sending an HTTP POST request composed of a FHIR Bundle Resource containing one List resource, one or more FHIR Media resources, one or more Binary resources, one Patient resource, and zero or one Practitioner resource to the XIS recipient. References to the FHIR specification for the required transaction and POST requests are given in the [[#Interactions.2C_operations.2C_search_parameters|interactions, operations and search parameters]] section below. |
The PHR executes an HTTP POST against the XIS's base endpoint as shown below. | The PHR executes an HTTP POST against the XIS's base endpoint as shown below. | ||
| Regel 138: | Regel 104: | ||
</pre> | </pre> | ||
| − | The PHR shall | + | The PHR shall guarantee consistency of all FHIR resource elements with the requirements specified in the StructureDefinitions for List, Media, Patient, Practitioner, PractitionerRole and Organization resources. References to these StructureDefinitions are provided in [[#List_of_StructureDefinitions|list of StructureDefinitions]]. |
==== Textual Requirements ==== | ==== Textual Requirements ==== | ||
| − | * The Bundle.type shall be transaction. | + | * The Bundle.type shall be 'transaction'. |
| − | * The | + | * The Bundle contains one List resource that has one to three references to a Media resource. |
| − | * | + | * The Media.content.attachment.url points at the image content, which shall be included in the Bundle as a Binary resource. See FHIR Resolving references in Bundles at the [http://hl7.org/fhir/STU3/bundle.html#references FHIR specification] and use within MedMij at the [https://informatiestandaarden.nictiz.nl/wiki/MedMij:V2019.01_FHIR_IG#Use_of_the_reference_datatype MedMij Use case overarching principles]. |
| − | * | + | * Referenced Resources (for example Patient, Practitioner and PractitionerRole) shall be included in the Bundle. |
* Accompanying text from the patient for the image and/or collection of images shall be placed in the Media.note and List.note respectively. | * Accompanying text from the patient for the image and/or collection of images shall be placed in the Media.note and List.note respectively. | ||
=== Examples === | === Examples === | ||
| − | + | {{Sjabloon:Voorbeelden}} | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
=== Server - XIS response === | === Server - XIS response === | ||
| − | The XIS shall process the bundle atomically. | + | The XIS shall process the bundle atomically. |
| + | |||
| + | ==== Response message ==== | ||
| + | The XIS response message shall be sent when a success or error condition needs to be communicated. Success is only indicated once the image(s) and accompanying resources are received and completely processed and persisted as appropriate to the XIS configuration. The XIS returns an HTTP Status code appropriate to the processing outcome, conforming to the transaction specification requirements as specified in the FHIR specification. | ||
| + | |||
| + | To enable the PHR to know the outcome of processing the transaction, and the identities assigned to the resources by the XIS, the XIS shall return a Bundle, with type set to transaction-response, that contains one entry for each entry in the request, in the same order as received, with the Bundle.entry.response.outcome indicating the results of processing the entry. The XIS shall comply with FHIR [http://hl7.org/fhir/STU3/bundle.html#transaction-response Bundle transaction-response] and [http://hl7.org/fhir/STU3/http.html#transaction-response the HTTP transaction-response] specifications. | ||
| + | |||
| + | ==== Handling errors ==== | ||
| + | A client may use the returned Bundle to track the outcomes of processing the entries, and the identities assigned to the resources by the server. Each entry element SHALL contain a response element which details the outcome of processing the entries - the HTTP status code, and the location and ETag header values, which are used for identifying and versioning the resources. In addition, a resource may be included in the entry, as specified by the Prefer header. | ||
| − | + | When the resource syntax or data is incorrect or invalid, and cannot be used to create a new resource, the server returns a 400 Bad Request HTTP status code. When the server rejects the content of the resource because of business rules, the server returns a 422 Unprocessable Entity error HTTP status code. In either case, the server SHOULD include a response body containing an OperationOutcome with detailed error messages describing the reason for the error. | |
| − | + | Common HTTP Status codes returned on FHIR-related errors (in addition to normal HTTP errors related to security, header and content type negotiation issues): | |
| − | + | * 400 Bad Request - resource could not be parsed or failed basic FHIR validation rules. | |
| + | * 404 Not Found - resource type not supported, or not a FHIR end-point. | ||
| + | * 422 Unprocessable Entity - the proposed resource violated applicable FHIR profiles or server business rules. This should be accompanied by an OperationOutcome resource providing additional detail. | ||
| + | |||
| + | Read more: | ||
| + | [http://hl7.org/fhir/STU3/http.html#create create] | ||
| + | [http://hl7.org/fhir/STU3/http.html#transaction transaction] | ||
=== Server - XIS & XDS === | === Server - XIS & XDS === | ||
| − | If the receiving XIS is part of a XDS network, it | + | {{NoteBox|This non-normative section provides advice for receiving XIS actors that want to persist images in an XDS network. MedMij information standards concern the exchange of healthcare information between PHR and XIS systems that act within the MedMij network. The possible backend of those systems is out of scope for the normative section of the information standard.}} |
| + | |||
| + | If the receiving XIS is part of a XDS network, it may need to convert the PHR request message into a proper message for the IHE "Provide and Register Document Set-b [ITI-41]" transaction. The XIS shall create appropriate metadata from the resources in the FHIR Bundle. The PHR provides the minimally required metadata. A mapping is shown below to assist in creating the XDS entry. The FHIR Media resource is mapped to the mandatory elements in the IHE MHD Profile on "DocumentReference with Comprehensive (aka XDS-on-FHIR) Metadata". IHE MHD defined these elements as a minimum for a XDS DocumentEntry. The Media and List StructureDefinition, provided in the [https://informatiestandaarden.nictiz.nl/wiki/MedMij:V2019.01_FHIR_Images#List_of_StructureDefinitions list of StructureDefinitions], contain mappings to a XDS DocumentEntry and XDS Folder Metadata Attributes respectively. Some FHIR elements do not translate to XDS concepts; the handling of these elements is left to the implementer of the XIS. | ||
| − | Upon successful conversion of the FHIR Bundle to XDS metadata, the XIS shall execute the Provide and Register Document Set-b [ITI-41] transaction. The transaction result and any error or warning messages | + | Upon successful conversion of the FHIR Bundle to XDS metadata, the XIS shall execute the Provide and Register Document Set-b [ITI-41] transaction. The transaction result and any error or warning messages shall be reported to the PHR. The XIS is responsible for translating the XDS response to the appropriate HTTP Status Code and FHIR OperationOutcome Resource in the Send Image Bundle Response Message. |
==== Mapping Media to mandatory IHE MHD DocumentReference elements needed for XDS DocumentEntry ==== | ==== Mapping Media to mandatory IHE MHD DocumentReference elements needed for XDS DocumentEntry ==== | ||
| Regel 197: | Regel 171: | ||
|- | |- | ||
| DocumentReference.class | | DocumentReference.class | ||
| − | | | + | | |
| − | | | + | | Fixed SNOMED code: 9491000146107 - Imaging documentation (record artifact). |
|- | |- | ||
| DocumentReference.subject | | DocumentReference.subject | ||
| Regel 241: | Regel 215: | ||
|} | |} | ||
| − | A number of fixed values can be used in indexing to a XDS network based on an image sent by a patient. These are status, type, security (if no value is given in the Media.meta.security element) and format. | + | A number of fixed values can be used in indexing to a XDS network based on an image sent by a patient. These are status, type, class, security (if no value is given in the Media.meta.security element) and format. |
| + | |||
| + | ====IHE MHD StructureDefinitions==== | ||
| + | IHE has defined StructureDefinitions and other Conformance resources applicable to this use case. The FHIR Implementation Guide on the '''[http://wiki.ihe.net/index.php/Mobile_access_to_Health_Documents_(MHD)#FHIR_Implementation_Guide IHE MHD wiki]''' lists these StructureDefinitions. | ||
| − | + | * IHE MHD profile on Provide Document Bundle (ITI-65) transaction with Comprehensive Metadata | |
| − | + | ** Canonical URL: {{Simplifier|http://ihe.net/fhir/StructureDefinition/IHE.MHD.ProvideDocumentBundle.Comprehensive|nictiz.fhir.nl.stu3.zib2017|pkgVersion=1.3.12}} | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | + | * IHE MHD Profile on DocumentReference (DocumentEntry) when used in the Provide Transaction with Comprehensive (aka XDS-on-FHIR) Metadata | |
| − | {{ | + | ** Canonical URL: {{Simplifier| http://ihe.net/fhir/StructureDefinition/IHE.MHD.Provide.Comprehensive.DocumentReference|nictiz.fhir.nl.stu3.zib2017|pkgVersion=1.3.12}} |
| − | |||
| − | |||
| − | |||
==Interactions, operations, search parameters== | ==Interactions, operations, search parameters== | ||
| Regel 293: | Regel 240: | ||
==List of StructureDefinitions== | ==List of StructureDefinitions== | ||
| − | + | {{NoteBoxPackage|https://simplifier.net/NictizSTU3-Zib2017/~packages|1.3.x|MedMij:V2019.01_FHIR_IG}} | |
| − | |||
| − | {{NoteBoxPackage|https://simplifier.net/packages | ||
{| class="wikitable" width="1400px" | {| class="wikitable" width="1400px" | ||
|-style="background-color: #1F497D; color: white; font-weight: bold; " | |-style="background-color: #1F497D; color: white; font-weight: bold; " | ||
| − | | | + | | HCIM NL / Concept||HCIM EN / Concept||FHIR Resource||URL profile |
|-style="vertical-align:top; background-color: #E3E3E3; | |-style="vertical-align:top; background-color: #E3E3E3; | ||
|- | |- | ||
| Patient | | Patient | ||
| − | | # | + | | #Zib Patient|Patient |
| Patient | | Patient | ||
| − | | [https://simplifier.net/ | + | | [https://simplifier.net/search?canonical=http://fhir.nl/fhir/StructureDefinition/nl-core-patient http://fhir.nl/fhir/StructureDefinition/nl-core-patient] |
|- | |- | ||
| − | | Zorgverlener | + | | rowspan="2" | Zorgverlener |
| − | | HealthProfessional | + | | rowspan="2" | HealthProfessional |
| Practitioner | | Practitioner | ||
| − | | | + | | {{Simplifier|http://fhir.nl/fhir/StructureDefinition/nl-core-practitioner|nictiz.fhir.nl.stu3.zib2017|pkgVersion=1.3.12}} |
| + | |- | ||
| + | | PractitionerRole | ||
| + | | {{Simplifier|http://fhir.nl/fhir/StructureDefinition/nl-core-practitionerrole|nictiz.fhir.nl.stu3.zib2017|pkgVersion=1.3.12}} | ||
|- | |- | ||
| Zorgaanbieder | | Zorgaanbieder | ||
| HealthcareProvider | | HealthcareProvider | ||
| Organization | | Organization | ||
| − | | | + | | {{Simplifier|http://fhir.nl/fhir/StructureDefinition/nl-core-organization|nictiz.fhir.nl.stu3.zib2017|pkgVersion=1.3.12}} |
|- | |- | ||
| Beeld | | Beeld | ||
| Image | | Image | ||
| Media | | Media | ||
| − | | | + | | {{Simplifier|http://nictiz.nl/fhir/StructureDefinition/images-Media|nictiz.fhir.nl.stu3.zib2017|pkgVersion=1.3.12}} |
|- | |- | ||
| CollectieBeelden | | CollectieBeelden | ||
| CollectionImages | | CollectionImages | ||
| List | | List | ||
| − | | | + | | {{Simplifier|http://nictiz.nl/fhir/StructureDefinition/images-List|nictiz.fhir.nl.stu3.zib2017|pkgVersion=1.3.12}} |
|- | |- | ||
| − | |||
| − | |||
| − | |||
| − | |||
|} | |} | ||
| + | {{Sjabloon:Voorbeelden}} | ||
| − | + | =Release notes= | |
| − | + | Release notes can be found on the [[MedMij:V2019.01_OntwerpBeelden#Release_notes|functional design page]]. | |
| − | + | {{EindUitgefaseerd}} | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | Release notes can be found on the [[MedMij: | ||
| − | |||
| − | |||
| − | { | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
Huidige versie van 25 okt 2022 om 09:32
|
|
Deze versie van de informatiestandaard is per 11-10-2021 uitgefaseerd. Zie de MedMij-overzichtspagina voor de actuele versies van de MedMij-informatiestandaarden. This version of this information standard has been deprecated as of 11-10-2021. Consult the MedMij overview page for the current versions of MedMij information standards. |
1 Introduction
This page describes the exchange of images within MedMij. Contrary to other MedMij use cases, we have not identified an existing information standard nor any specifically applicable HCIM? models. To achieve exchange of images, MedMij adopts as much as possible from existing standards, such as the DICOM standard and the Mobile access to Health Documents (MHD) profile from Integrating the Healthcare Enterprise (IHE) that defines a RESTful/HTTP interface to an XDS environment using HL7 FHIR STU3 resources.
|
|
This specification builds off IHE MHD which usually serves as an IHE XDS compatible frontend. However having an XDS network on either sending or receiving side is not a requirement per this specification. |
The specification currently consists of one use case, that covers sending an image by a patient to a healthcare provider. We anticipate adding a use case to retrieve images by the patient in a future version of this specification. This will most likely will be based on DICOMweb™, which is the DICOM standard for web-based medical imaging based on RESTful services.
Note: this page is part of the MedMij FHIR Implementation Guide and is a technical representation of its functional design.
2 Actors and transactions involved
Table 1 shows the relevant actors, systems and FHIR capability statements in a MedMij context. The capability statements demonstrate the minimum requirements to be in conformance with the described use cases.
| Persons | Systems | FHIR Capability Statements | |||
|---|---|---|---|---|---|
| Name | Description | Name | Description | Name | Description |
| Patient | The user of a personal healthcare environment. | PHR | Personal health record |  CapabilityStatement: Client
|
Image FHIR Client requirements |
| Healthcare Provider | The user of a XIS | XIS | Healthcare information system | CapabilityStatement: Server
|
Image FHIR Server requirements |
Table 1. Actors, systems and FHIR capability statements
3 Boundaries and Relationships
The use case where an image is sent from a PHR to a XIS is influenced by the IHE MHD profile with regards to the PHR message semantics and mandatory elements. The main deviation of these use-case specifications is the use of the FHIR Media resource instead of the DocumentReference resource. Although the DocumentReference is in line with the requirements of persisting content in an XDS network and the DocumentReference can handle images, the Media resource is more appropriate and specific for the exchange of images. The Media resource has additional, relevant, (medical related) elements compared to the DocumentReference. These are the Media elements view, reasonCode, bodySite, device and to a lesser extent the height and width elements. In addition, the Media resource has a reference coming from the DiagnosticReport that may be of value for further development of the MedMij information standard for images.
A XIS can possibly act within a XDS network. MedMij information standards have the primary objective to enable standardized communication between the parties that act within MedMij. As a secondary objective, exchange with parties that are part of a XDS networks are taken into account. For this objective, the PHR will need to provide additional meta information to the Media resource. The additional meta information allows XIS actors to index an image properly within a XDS network. The XIS is responsible for converting the PHR message into a XDS DocumentEntry. A mapping from the Media resource to the mandatory metadata elements of the IHE MHD DocumentReference resource is provided. The IHE MHD and general IHE XDS profiles will provide the information needed to produce a successful DocumentEntry for an image.
4 Use case: send image from a PHR to a XIS
This FHIR implementation guide assumes that the PHR system is able to make a connection to the right XIS that contains the patient's information. It does not provide information on finding the right XIS nor does it provide information about security. Moreover, each transaction is performed in the context of a specific authenticated patient, for whose context (token) has been established using the authentication mechanisms described in the 'Afsprakenstelsel'. Each XIS Gateway is required to perform filtering based on the patient associated with the context for the request, so only the records associated with the authenticated patient are returned. For this reason, search parameters should not be included for patient identification.
4.1 Introduction
This use case describes the minimal required technical functionalities in order to exchange an image made by the patient to a healthcare provider. Typical process flow would be:
- Patients creates, downloads or receives an image and uploads it to his PHR.
- The PHR sends the image to the chosen XIS system.
- Potentially the patient needs to provide sufficient metadata concerning the image.
- A healthcare provider views the image in his XIS.
This use case presumes made agreements between the patient and healthcare provider. Besides a technical answer by the XIS of the healthcare provider, no answer to the patient is expected.
The following technical specifications will concern the process mentioned in bullet 2.
4.2 Actors
| Transaction group | Transaction | Actor | Role |
|---|---|---|---|
| Send Image Bundle (PUSH) | Send image bundle request | Patient (using a PHR) | Sends image to the XIS |
| Receive image bundle response | Healthcare professional (using a XIS) | Receives image from PHR |
4.3 Invocations
4.3.1 Client - PHR request
When the patient (PHR) wants to send one or more images, it issues a send image bundle request message.
The PHR initiates a FHIR transaction using a create action by sending an HTTP POST request composed of a FHIR Bundle Resource containing one List resource, one or more FHIR Media resources, one or more Binary resources, one Patient resource, and zero or one Practitioner resource to the XIS recipient. References to the FHIR specification for the required transaction and POST requests are given in the interactions, operations and search parameters section below.
The PHR executes an HTTP POST against the XIS's base endpoint as shown below.
POST [base] {?_format=[mime-type]}
The PHR shall guarantee consistency of all FHIR resource elements with the requirements specified in the StructureDefinitions for List, Media, Patient, Practitioner, PractitionerRole and Organization resources. References to these StructureDefinitions are provided in list of StructureDefinitions.
4.3.1.1 Textual Requirements
- The Bundle.type shall be 'transaction'.
- The Bundle contains one List resource that has one to three references to a Media resource.
- The Media.content.attachment.url points at the image content, which shall be included in the Bundle as a Binary resource. See FHIR Resolving references in Bundles at the FHIR specification and use within MedMij at the MedMij Use case overarching principles.
- Referenced Resources (for example Patient, Practitioner and PractitionerRole) shall be included in the Bundle.
- Accompanying text from the patient for the image and/or collection of images shall be placed in the Media.note and List.note respectively.
4.3.2 Examples
Example instances of FHIR resources can be found on Simplifier. Please note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of any information standard.
4.3.3 Server - XIS response
The XIS shall process the bundle atomically.
4.3.3.1 Response message
The XIS response message shall be sent when a success or error condition needs to be communicated. Success is only indicated once the image(s) and accompanying resources are received and completely processed and persisted as appropriate to the XIS configuration. The XIS returns an HTTP Status code appropriate to the processing outcome, conforming to the transaction specification requirements as specified in the FHIR specification.
To enable the PHR to know the outcome of processing the transaction, and the identities assigned to the resources by the XIS, the XIS shall return a Bundle, with type set to transaction-response, that contains one entry for each entry in the request, in the same order as received, with the Bundle.entry.response.outcome indicating the results of processing the entry. The XIS shall comply with FHIR Bundle transaction-response and the HTTP transaction-response specifications.
4.3.3.2 Handling errors
A client may use the returned Bundle to track the outcomes of processing the entries, and the identities assigned to the resources by the server. Each entry element SHALL contain a response element which details the outcome of processing the entries - the HTTP status code, and the location and ETag header values, which are used for identifying and versioning the resources. In addition, a resource may be included in the entry, as specified by the Prefer header.
When the resource syntax or data is incorrect or invalid, and cannot be used to create a new resource, the server returns a 400 Bad Request HTTP status code. When the server rejects the content of the resource because of business rules, the server returns a 422 Unprocessable Entity error HTTP status code. In either case, the server SHOULD include a response body containing an OperationOutcome with detailed error messages describing the reason for the error.
Common HTTP Status codes returned on FHIR-related errors (in addition to normal HTTP errors related to security, header and content type negotiation issues):
- 400 Bad Request - resource could not be parsed or failed basic FHIR validation rules.
- 404 Not Found - resource type not supported, or not a FHIR end-point.
- 422 Unprocessable Entity - the proposed resource violated applicable FHIR profiles or server business rules. This should be accompanied by an OperationOutcome resource providing additional detail.
Read more: create transaction
4.3.4 Server - XIS & XDS
|
|
This non-normative section provides advice for receiving XIS actors that want to persist images in an XDS network. MedMij information standards concern the exchange of healthcare information between PHR and XIS systems that act within the MedMij network. The possible backend of those systems is out of scope for the normative section of the information standard. |
If the receiving XIS is part of a XDS network, it may need to convert the PHR request message into a proper message for the IHE "Provide and Register Document Set-b [ITI-41]" transaction. The XIS shall create appropriate metadata from the resources in the FHIR Bundle. The PHR provides the minimally required metadata. A mapping is shown below to assist in creating the XDS entry. The FHIR Media resource is mapped to the mandatory elements in the IHE MHD Profile on "DocumentReference with Comprehensive (aka XDS-on-FHIR) Metadata". IHE MHD defined these elements as a minimum for a XDS DocumentEntry. The Media and List StructureDefinition, provided in the list of StructureDefinitions, contain mappings to a XDS DocumentEntry and XDS Folder Metadata Attributes respectively. Some FHIR elements do not translate to XDS concepts; the handling of these elements is left to the implementer of the XIS.
Upon successful conversion of the FHIR Bundle to XDS metadata, the XIS shall execute the Provide and Register Document Set-b [ITI-41] transaction. The transaction result and any error or warning messages shall be reported to the PHR. The XIS is responsible for translating the XDS response to the appropriate HTTP Status Code and FHIR OperationOutcome Resource in the Send Image Bundle Response Message.
4.3.4.1 Mapping Media to mandatory IHE MHD DocumentReference elements needed for XDS DocumentEntry
| IHE MHD Profile on DocumentReference with Comprehensive (aka XDS-on-FHIR) Metadata | Media for images, used by the PHR | Implementation notes for XIS & XDS |
|---|---|---|
| DocumentReference.masterIdentifier | Media.identifier | |
| DocumentReference.status | Fixed value "current". | |
| DocumentReference.type | Media.type | Fixed LOINC code: 72170-4 Photographic image Unspecified body region Document. |
| DocumentReference.class | Fixed SNOMED code: 9491000146107 - Imaging documentation (record artifact). | |
| DocumentReference.subject | Media.subject | |
| DocumentReference.indexed | Media.occurrenceDateTime | |
| DocumentReference.securityLabel | Media.meta.security | If no value is present 'normal' should be used as default. |
| DocumentReference.content | Media.content | |
| DocumentReference.content.attachment | Media.content.attachment | |
| DocumentReference.content.attachment.contentType | Media.content.attachment.contentType | Possible media content types: JPEG, PNG, GIF, JP2. |
| DocumentReference.content.attachment.url | Media.content.attachment.url | |
| DocumentReference.content.attachment.size | Media.content.attachment.size | |
| DocumentReference.content.attachment.hash | Media.content.attachment.hash | |
| DocumentReference.content.format | Fixed value "mimeType Sufficient". |
A number of fixed values can be used in indexing to a XDS network based on an image sent by a patient. These are status, type, class, security (if no value is given in the Media.meta.security element) and format.
4.3.4.2 IHE MHD StructureDefinitions
IHE has defined StructureDefinitions and other Conformance resources applicable to this use case. The FHIR Implementation Guide on the IHE MHD wiki lists these StructureDefinitions.
- IHE MHD profile on Provide Document Bundle (ITI-65) transaction with Comprehensive Metadata
- IHE MHD Profile on DocumentReference (DocumentEntry) when used in the Provide Transaction with Comprehensive (aka XDS-on-FHIR) Metadata
4.4 Interactions, operations, search parameters
4.4.1 Interactions
The following logical interactions are needed for this use case:
4.4.2 Operations
There are no defined operations for this use case.
4.4.3 Search parameters
There are no search parameters needed for this use case.
4.5 List of StructureDefinitions
|
|
MedMij uses the FHIR Packaging mechanism. This conveniently bundles all examples, profiles and other conformance resources you need into a single download. For more background information see the the FHIR implementation guide. This version of the information standard depends on Nictiz package 1.3.x. Please note that the direct links to the various conformance resources below will take you to the latest version, which might not match the package version. At time of writing, there is no way to render the conformance resource as found in the package. This is on the roadmap for Simplifier. |
| HCIM NL / Concept | HCIM EN / Concept | FHIR Resource | URL profile |
| Patient | Patient | Patient | http://fhir.nl/fhir/StructureDefinition/nl-core-patient |
| Zorgverlener | HealthProfessional | Practitioner | http://fhir.nl/fhir/StructureDefinition/nl-core-practitioner |
| PractitionerRole | http://fhir.nl/fhir/StructureDefinition/nl-core-practitionerrole | ||
| Zorgaanbieder | HealthcareProvider | Organization | http://fhir.nl/fhir/StructureDefinition/nl-core-organization |
| Beeld | Image | Media | http://nictiz.nl/fhir/StructureDefinition/images-Media |
| CollectieBeelden | CollectionImages | List | http://nictiz.nl/fhir/StructureDefinition/images-List |
Example instances of FHIR resources can be found on Simplifier. Please note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of any information standard.
5 Release notes
Release notes can be found on the functional design page.