CH EPR FHIR (R4)
4.0.1-ballot-2 - ballot Switzerland flag

CH EPR FHIR (R4), published by eHealth Suisse. This guide is not an authorized publication; it is the continuous build for version 4.0.1-ballot-2 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/ehealthsuisse/ch-epr-fhir/ and changes regularly. See the Directory of published versions

Care Services Feed [CH:mCSD-1]

This section corresponds to transaction [CH:mCSD-1]. Transaction [CH:mCSD-1] is used by the Care Services Source and Care Services Directory Actors.

Scope

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 Roles

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

Referenced Standards

  1. This Profile is based on Release 4 of the HL7® FHIR® standard.

Messages

Interaction Diagram for [CH:mCSD-1]Care Services SourceCare Services DirectoryAddAdd Care Service RequestAdd Care Services ResponseUpdateUpdate Care Service RequestUpdate Care Services ResponseDeleteDelete Care Service RequestDelete Care Services Response

Add Care Service Request Message

The Add Care Service Request Message provides the ability to submit new care service resources (Practitioner, PractitionerRole or Organization) to a directory.

Trigger Events

The Add Care Service Request Message is triggered when a Care Services Source needs to transmit new Care Services resource.

Message Semantics

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.

Example
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
}
Expected Actions

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.

Response Message

See https://hl7.org/fhir/R4/http.html#create for the response.

Update Care Service Request Message

The Update Care Service Request Message provides the ability to submit updated care service resources (Practitioner, PractitionerRole or Organization) to a directory.

Trigger Events

The Update Care Service Request Message is triggered when a Care Services Source needs to transmit updated Care Services resource.

Message Semantics

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.

Example
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
}
Expected Actions

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.

Response Message

See https://hl7.org/fhir/R4/http.html#update for the response.

Delete Care Service Request Message

The Delete Care Service Request Message provides the ability to delete care service resources (Practitioner, PractitionerRole or Organization) from a directory.

Trigger Events

The Delete Care Service Request Message is triggered when a Care Services Source wants to delete Care Services resource.

Message Semantics

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.

Example
DELETE [base]/Practitioner/hcp-42 HTTP/1.1
traceparent: 00-0af7651916cd43dd8448eb211c80319c-b7ad6b7169203331-00
Expected Actions

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.

Response Message

See https://hl7.org/fhir/R4/http.html#delete for the response.

Security Consideration

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.

Security Audit Considerations

The Care Services Source and Care Services Directory shall record the right audit event for the operations:

Consideration when implementing the mCSD profile with an LDAP backend (HPD)

When implementing the mCSD profile with an LDAP backend (such as the HPD),

  • An informative mapping between the FHIR resources and the LDAP entries is provided in the mapping tab of the respective FHIR profiles.
  • When the Source adds a new Care Services resource, the FHIR gateway doing the mapping is responsible for determining the LDAP DN of the new entry (either by using the provided LDAP DN, if any, or by generating a new one).
  • When the Source updates or delete a Care Services resource, the FHIR gateway is responsible for finding the corresponding LDAP entry, using the provided resource id.