CH EPR FHIR (R4)
4.0.1 - trial-use
CH EPR FHIR (R4)
4.0.1 - trial-use
This page is part of the CH EPR FHIR (R4) (v4.0.1: DSTU 4) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions
This section corresponds to transaction [CH:mCSD-1]. Transaction [CH:mCSD-1] is used by the Care Services Source and Care Services Directory Actors.
The Care Services Feed [CH:mCSD-1] transaction is used to add, update and delete Care Services information from the Care Services Source to the Care Services Directory.
Actor: Care Services Source
Role: Prepares and issues an add, update, or delete request to Care Services resources
Actor: Care Services Directory
Role: Accepts add, update, or delete requests to Care Services resources
The Add Care Service Request Message provides the ability to submit new care service resources (Practitioner, PractitionerRole or Organization) to a directory.
The Add Care Service Request Message is triggered when a Care Services Source needs to transmit new Care Services resource.
A Care Services Source initiate a FHIR Create operation on a Practitioner, PractitionerRole or Organization resource, with a standalone HTTP request or a batch transaction.
A Care Services Source shall send a request for either the JSON or the XML format as defined in FHIR. A Care Services Directory shall support the JSON and the XML format.
The Care Services Directory shall be capable of accepting elements specified in the profiles CH mCSD Practitioner, CH mCSD PractitionerRole and CH mCSD Organization.
POST [base]/Organization HTTP/1.1
Content-Type: application/fhir+json
Accept: application/fhir+json
traceparent: 00-0af7651916cd43dd8448eb211c80319c-b7ad6b7169203331-00
{
// Content of the Organization to add
}
The Care Services Directory shall provide a CapabilityStatement with the capabilities interaction and indicate that Create is available on the Practitioner, PractitionerRole and Organization resources.
The Care Services Directory shall process the Add Care Services Request Message.
See https://hl7.org/fhir/R4/http.html#create for the response.
The Update Care Service Request Message provides the ability to submit updated care service resources (Practitioner, PractitionerRole or Organization) to a directory.
The Update Care Service Request Message is triggered when a Care Services Source needs to transmit updated Care Services resource.
A Care Services Source initiate a FHIR Update operation on a Practitioner, PractitionerRole or Organization resource, with a standalone HTTP request or a batch transaction.
A Care Services Source shall send a request for either the JSON or the XML format as defined in FHIR. A Care Services Directory shall support the JSON and the XML format.
The Care Services Directory shall be capable of accepting elements specified in the profiles CH mCSD Practitioner, CH mCSD PractitionerRole and CH mCSD Organization.
PUT [base]/Organization/org-723 HTTP/1.1
Content-Type: application/fhir+json
Accept: application/fhir+json
traceparent: 00-0af7651916cd43dd8448eb211c80319c-b7ad6b7169203331-00
{
// Content of the Organization to update
}
The Care Services Directory shall provide a CapabilityStatement with the capabilities interaction and indicate that Conditional Update is available on the Practitioner, PractitionerRole and Organization resources.
The Care Services Directory shall process the Update Care Services Request Message. If the search parameters identify multiple resources, the Care Services Directory shall return an error.
See https://hl7.org/fhir/R4/http.html#update for the response.
The Delete Care Service Request Message provides the ability to delete care service resources (Practitioner, PractitionerRole or Organization) from a directory.
The Delete Care Service Request Message is triggered when a Care Services Source wants to delete Care Services resource.
A Care Services Source initiate a FHIR Delete operation on a Practitioner, PractitionerRole or Organization resource, with a standalone HTTP request or a batch transaction.
DELETE [base]/Practitioner/hcp-42 HTTP/1.1
traceparent: 00-0af7651916cd43dd8448eb211c80319c-b7ad6b7169203331-00
The Care Services Directory shall provide a CapabilityStatement with the capabilities interaction and indicate that Conditional Delete is available on the Practitioner, PractitionerRole and Organization resources.
The Care Services Directory shall process the Delete Care Services Request Message. If the search parameters identify multiple resources, the Care Services Directory shall return an error.
See https://hl7.org/fhir/R4/http.html#delete for the response.
TLS SHALL be used. This national extension enforces authentication and authorization of access to the Care Services Directory using the IUA profile with basic access token. Consequently the Add/Update/Delete Care Services [CH:mCSD-1] request must authorize using the [ITI-72] transaction of the IUA profile.
The actors SHALL support the traceparent header handling, as defined in Appendix: Trace Context.
The Care Services Source and Care Services Directory shall record the right audit event for the operations:
When implementing the mCSD profile with an LDAP backend (such as the HPD),