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

This page is part of the CH EPR FHIR (R4) (v4.0.1-ballot-2: DSTU 4 Ballot 3) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

Artifacts Summary

This page provides a list of the FHIR artifacts defined as part of this implementation guide.

Behavior: Capability Statements

The following artifacts define the specific capabilities that different types of systems are expected to have in order to comply with this implementation guide. Systems conforming to this implementation guide are expected to declare conformance to one or more of the following capability statements.

ATNA Audit Creator (client)

CapabilityStatement for Client Actor in the IHE IT Infrastructure Technical Framework Supplement Add RESTful ATNA.

ATNA Audit Record Repository (server)

CapabilityStatement for Server Actor in the IHE IT Infrastructure Technical Framework Supplement Add RESTful ATNA.

EPR API (server)

CapabilityStatement for EPR API (server).

EPR App (client)

CapabilityStatement for EPR App (client).

MHD Document Consumer (client)

CapabilityStatement for Actor MHD Document Consumer (client).

MHD Document Recipient (server)

CapabilityStatement for Actor MHD Document Recipient (server).

MHD Document Responder (server)

CapabilityStatement for Actor MHD Document Responder (server).

MHD Document Source (client)

CapabilityStatement for Actor MHD Document Source (client).

PDQm Consumer (client)

CapabilityStatement for Client Actor in the IHE IT Infrastructure Technical Framework Supplement IHE PDQm.

PDQm Supplier (server)

CapabilityStatement for Server Actor in the IHE IT Infrastructure Technical Framework Supplement IHE PDQm.

PIXm Patient Identifier Cross-Reference Consumer (client)

The Patient Identifier Cross-reference Consumer Actor CapabilityStatement expresses the requirements that can be utilized while being compliant. - using FHIR R4 - using json or xml encoding - query the $ihe-pix operation

PIXm Patient Identifier Cross-reference Manager (server)

The Patient Identifier Cross-reference Manager CapabilityStatement expresses the requirements that shall be provided. - using FHIR R4 - using json and xml encoding - support the $ihe-pix operation - support conditional update for [ITI-104] - support conditional delete for [ITI-104] if Remove Patient Option is supported - used with IHE-IUA

PIXm Patient Identity Source (client)

The Patient Identity Source Actor CapabilityStatement expresses the requirements that can be utilized while being compliant. - using FHIR R4 - using json or xml encoding - using conditional update for [ITI-104] - provide supported Patient profile for crosss-referencing for [ITI-104]

PPQm Policy Repository (server)

CapabilityStatement for the Policy Repository actor in the CH:PPQm profile (server).

PPQm Policy Source and Consumer (client)

CapabilityStatement for the Policy Source and Policy Consumer actors in the CH:PPQm profile (client).

mCSD Care Services Directory (server)

CapabilityStatement for Server Actor in the Swiss mCSD profile extension.

mCSD Care Services Selective Consumer (client)

CapabilityStatement for Client Actor in the IHE IT Infrastructure Technical Framework Supplement IHE mCSD.

mCSD Care Services Selective Supplier (server)

CapabilityStatement for Server Actor in the IHE IT Infrastructure Technical Framework Supplement IHE mCSD.

mCSD Care Services Source (client)

CapabilityStatement for Server Actor in the Swiss mCSD profile extension.

Behavior: Operation Definitions

These are custom operations that can be supported by and/or invoked by systems conforming to this implementation guide.

CH PDQm $Match

This operation implements the Patient Demographics Match [ITI-119] transaction. It is fully compatible with the $match Operation on Patient. The only changes are to constrain the input parameters to use the PDQm Patient Profile for $match Input profile and to constring the output parameters to use the PDQm Patient Profile profile.

PIXm Find patient matches

Find patient matches using IHE-PIXm Profile

Structures: Resource Profiles

These define constraints on FHIR resources for systems conforming to this implementation guide.

CH Audit Event for [CH:MHD-1] Document Recipient

This profile is used to define the CH Audit Event for the [CH:MHD-1] transaction and the actor 'Document Recipient'.

CH Audit Event for [CH:MHD-1] Document Source

This profile is used to define the CH Audit Event for the [CH:MHD-1] transaction and the actor 'Document Source'.

CH Audit Event for [CH:mCSD-1] Care Services Source & Directory / Add

This profile is used to define the CH Audit Event for the [CH:mCSD-1] transaction and the actors 'Care Services Source' & Directory, when adding care service resources.

CH Audit Event for [CH:mCSD-1] Care Services Source & Directory / Delete

This profile is used to define the CH Audit Event for the [CH:mCSD-1] transaction and the actors 'Care Services Source' & Directory, when deleting care service resources.

CH Audit Event for [CH:mCSD-1] Care Services Source & Directory / Update

This profile is used to define the CH Audit Event for the [CH:mCSD-1] transaction and the actors 'Care Services Source' & Directory, when updating care service resources.

CH Audit Event for [ITI-104] Patient Identifier Cross-reference Manager / Create patient

This profile is used to define the CH Audit Event for the [ITI-104] transaction and the actor 'Patient Identifier Cross-reference Manager' when creating a patient.

CH Audit Event for [ITI-104] Patient Identifier Cross-reference Manager / Update patient

This profile is used to define the CH Audit Event for the [ITI-104] transaction and the actor 'Patient Identifier Cross-reference Manager' when updating a patient.

CH Audit Event for [ITI-104] Patient Identity Source

This profile is used to define the CH Audit Event for the [ITI-104] transaction and the actor 'Patient Identity Source'.

CH Audit Event for [ITI-119] Patient Demographics Consumer

This profile is used to define the CH Audit Event for the [ITI-119] transaction and the actor 'Patient Demographics Consumer'.

CH Audit Event for [ITI-119] Patient Demographics Supplier

This profile is used to define the CH Audit Event for the [ITI-119] transaction and the actor 'Patient Demographics Supplier'.

CH Audit Event for [ITI-65] Document Recipient

This profile is used to define the CH Audit Event for the [ITI-65] transaction and the actor 'Document Recipient'.

CH Audit Event for [ITI-65] Document Source

This profile is used to define the CH Audit Event for the [ITI-65] transaction and the actor 'Document Source'.

CH Audit Event for [ITI-67] Document Consumer

This profile is used to define the CH Audit Event for the [ITI-67] transaction and the actor 'Document Consumer'.

CH Audit Event for [ITI-67] Document Responder

This profile is used to define the CH Audit Event for the [ITI-67] transaction and the actor 'Document Responder'.

CH Audit Event for [ITI-68] Document Consumer

This profile is used to define the CH Audit Event for the [ITI-68] transaction and the actor 'Document Consumer'.

CH Audit Event for [ITI-68] Document Responder

This profile is used to define the CH Audit Event for the [ITI-68] transaction and the actor 'Document Responder'.

CH Audit Event for [ITI-83] Patient Identifier Cross-reference Consumer

This profile is used to define the CH Audit Event for the [ITI-83] transaction and the actor 'Patient Identifier Cross-reference Consumer'.

CH Audit Event for [ITI-83] Patient Identifier Cross-reference Manager

This profile is used to define the CH Audit Event for the [ITI-83] transaction and the actor 'Patient Identifier Cross-reference Manager'.

CH Audit Event for [ITI-90] Care Services Selective Consumer & Supplier / Query

This profile is used to define the CH Audit Event for the [ITI-90] transaction and the actors 'Care Services Selective Consumer' & Supplier, when querying care service resources.

CH Audit Event for [ITI-90] Care Services Selective Consumer & Supplier / Read

This profile is used to define the CH Audit Event for the [ITI-90] transaction and the actors 'Care Services Selective Consumer' & Supplier, when reading care service resources.

CH Audit Event for [PPQ-3] Create privacy policy

This profile is used to define the CH Audit Event for the [PPQ-3] transaction and the actors 'Policy Source' and 'Policy Repository' when creating a privacy policy.

CH Audit Event for [PPQ-3] Delete privacy policy

This profile is used to define the CH Audit Event for the [PPQ-3] transaction and the actors 'Policy Source' and 'Policy Repository' when deleting a privacy policy.

CH Audit Event for [PPQ-3] Update privacy policy

This profile is used to define the CH Audit Event for the [PPQ-3] transaction and the actors 'Policy Source' and 'Policy Repository' when updating a privacy policy.

CH Audit Event for [PPQ-5] Policy Consumer

This profile is used to define the CH Audit Event for the [PPQ-5] transaction and the actor 'Policy Consumer'.

CH Audit Event for [PPQ-5] Policy Repository

This profile is used to define the CH Audit Event for the [PPQ-5] transaction and the actor 'Policy Repository'.

CH Audit Event with a Basic Auth Token

This is the profile for Swiss Audit Events when a transaction is secured with a Basic Authorization Token.

CH Audit Event with an Extended Auth Token

This is the profile for Swiss Audit Events when a transaction is secured with an Extended Authorization Token.

CH EPR FHIR AuditEvent

CH EPR FHIR profile on AuditEvent

CH MHD DocumentReference Comprehensive

CH MHD Profile on CH Core DocumentReference

CH MHD Find Document References Comprehensive Response message

A profile on the Find Document References Comprehensive Response message for ITI-68

CH MHD Provide Document Bundle Comprehensive

IHE MHD profile on Provide Document Bundle (ITI-65) transaction with Comprehensive Metadata for the Swiss EPR.

CH MHD Provide Document Bundle Comprehensive Response

IHE MHD profile on Response of Provide Document Bundle (ITI-65) transaction with Comprehensive Metadata.

CH MHD SubmissionSet Comprehensive

CH MHD SubmissionSet Comprehensive

CH PDQm Match Input Parameters Profile

The PDQm Match Input Parameters Profile describes the Parameters Resource that is to be posted to the $match endpoint when invoking ITI-119. This profile is consistent with the exceptions of the Patient-match operation in FHIR core, except the input resource SHALL be an instance of the PDQm Patient Profile for $match Input.

Note that the only REQUIRED parameter is the Patient Resource. When only the Patient is supplied, it can be POSTed directly to the $match endpoint without being wrapped in a Parameters Resource, as long as it conforms to the PDQm Patient Profile for $match Input.

CH PDQm Match Output Bundle Profile

A profile on the Query Patient Resource Response message for ITI-119

CH PDQm OperationOutcome More Attributes Requested

A profile on the OperationOutcome for indicating which additional attributes are requested to lower the results number.

CH PDQm Patient

The patient demographics and identifier information which can be provided in the PDQm response according to the EPR. If the patient is already registered in a community, the MPI-PID SHALL be provided as an identifier. The EPR-SPID as an identifier MAY be added. The birthname can be added with the ISO 21090 qualifier extension.

CH PDQm Patient Profile for $match Input

The PDQm Patient Profile for $match Input SHALL be provided as input to the ITI-119 transaction.

  • While it is not REQUIRED that the input to $match be a valid FHIR instance, it is RECOMMENDED to supply as many elements as possible to facilitate matching.
  • modifierExtension and implicitRules SHALL not be specified.
  • The ChEprFhirBirthName profile is available to hold the mother's maiden name
CH PDQm Provider Organization

Organization

CH PIXm IN Parameters

The StructureDefinition defines the Input Parameters for the $ihe-pix operation: - Input: sourceIdentifier, targetSystem

CH PIXm OUT Parameters

The StructureDefinition defines the Output Parameters for the $ihe-pix operation:

CH PIXm Patient Feed

The patient demographics and identifier information which can be provided in the PIXm Feed according to the EPR. The EPR-SPID as an identifier SHALL be added. The birthname can be added with the ISO 21090 qualifier extension.

CH PPQm Consent

Swiss EPR Policy Set as a Consent

CH PPQm Feed Request Bundle

Bundle for Mobile Privacy Policy Bundle Feed requests

CH PPQm Retrieve Response Bundle

Bundle for Mobile Privacy Policy Retrieve responses

CH mCSD Organization

CH mCSD profile on Organization

CH mCSD Practitioner

CH mCSD profile on Practitioner

CH mCSD PractitionerRole

CH mCSD profile on PractitionerRole

EPR policy set based on template 201

EPR policy set based on template 201 – grants the patient the full access to the their EPR. This policy set shall be created during the patient's onboarding.

EPR policy set based on template 202

EPR policy set based on template 202 – grants healthcare professionals access to the patient's EPR in emergency mode. This policy set shall be created during the patient's onboarding, but can be modified later.

EPR policy set based on template 203

EPR policy set based on template 203 – defines the minimal confidentiality level of documents. This policy set shall be created during the patient's onboarding, but can be modified later.

EPR policy set based on template 301

EPR policy set based on template 301 – gives a particular healthcare professional read access to the patient's EPR, without delegation rights.

EPR policy set based on template 302

EPR policy set based on template 302 – gives a group of healthcare professionals read access to the patient's EPR, without delegation rights.

EPR policy set based on template 303

EPR policy set based on template 303 – gives a representative full access to the patient's EPR.

EPR policy set based on template 304

EPR policy set based on template 304 – gives a particular healthcare professional read access to the patient's EPR, with delegation rights.

Structures: Data Type Profiles

These define constraints on FHIR data types for systems conforming to this implementation guide.

CH EPR FHIR BirthName

The birthname with the ISO 21090 qualifier https://www.hl7.org/fhir/extension-iso21090-en-qualifier.html BR

CH EPR FHIR HumanName

The humanname WITHOUT the ISO 21090 qualifier https://www.hl7.org/fhir/extension-iso21090-en-qualifier.html BR

LDAP Identifier

Identifier with an LDAP DN

Oid Identifier

Identifer with an oid

Structures: Extension Definitions

These define constraints on FHIR data types for systems conforming to this implementation guide.

CH Extension Author AuthorRole

Extension Author AuthorRole for SubmissionSet and DocumentEntry

CH Extension Deletion Status

Extension Deletion Status for DocumentReference

CH MHD Extension to provide the homeCommunityId

This CH MHD extension enables to proivde homeCommunityId in an OperationOutcome

Terminology: Value Sets

These define sets of codes used by systems conforming to this implementation guide.

CH PDQm ValueSet More Attributes Requested

Coded Values for indicating which additional attributes are requested to lower the results number.

CH PPQm Actor Identifier Type

Actor Identifier Types for CH:PPQm

CH PPQm Consent Identifier Type

Value Set for CH:PPQm Consent Identifier Types

CH PPQm Feed Request HTTP Method

HTTP methods allowed in CH:PPQm Feed requests

CH PPQm Policy Set Template ID

IDs of policy set templates

CH PPQm Referenced Policy Set for Default Provide (203) template

IDs of basis policy sets that may be referenced from template 203

CH PPQm Referenced Policy Set for Emergency Access (202) and HCP Group (302) templates

IDs of basis policy sets that may be referenced from templates 202 and 302

CH PPQm Referenced Policy Set for Healthcare Professionals with Delegation (304) template

IDs of basis policy sets that may be referenced from template 304

CH PPQm Referenced Policy Set for Healthcare Professionals without Delegation (301) template

IDs of basis policy sets that may be referenced from template 301

CH PPQm Referenced Policy Set for Patients (201) and Representative (303) templates

IDs of basis policy sets that may be referenced from templates 201 and 303

Terminology: Code Systems

These define new code systems used by systems conforming to this implementation guide.

CH Codesystem PDQ More Attributes Requested

Codes for indicating which additional attributes are requested to lower the results number.

CH PPQm Consent Identifier Type

Code system for CH:PPQm Consent Identifier Types

CH PPQm Policy Set Template ID

Code system for Policy Set Template IDs

IHE XCPD Codesystem more attributes requested

Codes for indicating which additional attributes are requested to lower the results number.

Example: Example Instances

These are example instances that show what data produced and consumed by systems conforming with this implementation guide might look like.

Example of audit event for a [CH:MHD-1] transaction at Recipient

This example shows an made by the Document Recipient for a CH:MHD-1 transaction.

Example of audit event for a [CH:MHD-1] transaction at Source

This example shows an made by the Document Source for a CH:MHD-1 transaction.

Example of audit event for a [CH:mCSD-1] create transaction

This example shows an AuditEvent made by the Care Services Source for a CH:mCSD-1 transaction that added a new PractitionerRole (relationship).

Example of audit event for a [CH:mCSD-1] delete transaction

This example shows an AuditEvent made by the Care Services Directory for a CH:mCSD-1 transaction that deleted an Organization.

Example of audit event for a [CH:mCSD-1] update transaction

This example shows an AuditEvent made by the Care Services Directory for a CH:mCSD-1 transaction that updated an existing Practitioner.

Example of audit event for a [PPQ-3] create transaction

This example shows an made by the Policy Source for a PPQ-3 transaction that added a new Consent.

Example of audit event for a [PPQ-3] delete transaction

This example shows an AuditEvent made by the Policy Source for a PPQ-3 transaction that deleted a Consent.

Example of audit event for a [PPQ-3] update transaction

This example shows an made by the Policy Repository for a PPQ-3 transaction that updated an existing Consent.

Example of audit event for a [PPQ-5] transaction at Consumer

This example shows an made by the Policy Consumer for a PPQ-5 transaction.

Example of audit event for a [PPQ-5] transaction at Repository

This example shows an made by the Policy Repository for a PPQ-5 transaction.

Example of audit event for an [ITI-104] add transaction at Manager

This example shows an made by the Patient Identifier Cross-reference Manager for an ITI-104 transaction that added a new Patient.

Example of audit event for an [ITI-104] transaction at Source

This example shows an made by the Patient Identity Source for an ITI-104 transaction.

Example of audit event for an [ITI-104] update transaction at Manager

This example shows an made by the Patient Identifier Cross-reference Manager for an ITI-104 transaction that revised an existing Patient.

Example of audit event for an [ITI-119] transaction at Consumer

This example shows an made by the Patient Demographics Consumer for an ITI-119 transaction.

Example of audit event for an [ITI-119] transaction at Supplier

This example shows an made by the Patient Demographics Supplier for an ITI-119 transaction.

Example of audit event for an [ITI-65] transaction at Recipient

This example shows an made by the Document Recipient for an ITI-65 transaction.

Example of audit event for an [ITI-65] transaction at Source

This example shows an made by the Document Source for an ITI-65 transaction.

Example of audit event for an [ITI-67] transaction at Consumer

This example shows an made by the Document Consumer for an ITI-67 transaction.

Example of audit event for an [ITI-67] transaction at Responder

This example shows an made by the Document Responder for an ITI-67 transaction.

Example of audit event for an [ITI-68] transaction at Consumer

This example shows an made by the Document Consumer for an ITI-68 transaction.

Example of audit event for an [ITI-68] transaction at Responder

This example shows an made by the Document Responder for an ITI-68 transaction.

Example of audit event for an [ITI-83] transaction at Consumer

This example shows an made by the Patient Identifier Cross-reference Consumer for an ITI-83 transaction.

Example of audit event for an [ITI-83] transaction at Manager

This example shows an made by the Patient Identifier Cross-reference Manager for an ITI-83 transaction.

Example of audit event for an [ITI-90] query transaction

This example shows an made by the Care Services Selective Supplier for an ITI-90 transaction that searched Practitioners.

Example of audit event for an [ITI-90] read transaction

This example shows an made by the Care Services Selective Consumer for an ITI-90 transaction that read an Organization.

Example of bundle of audit events for a [PPQ-4] transaction

This example shows a Bundle of AuditEvents made by the Policy Source for a PPQ-4 transaction.

MHD DocumentReference for MedicationCard

Example DocumentReference for a MedicationCard

MHD Find DocumentReferences

MHD Find DocumentReferences - Bundle as Response

MHD OperationOutcome DocumentReference udpate error identifiers

Error OperationOutcome that the updated DocumentReference has not same values for the identifiers

MHD OperationOutcome DocumentReference udpate error patient id reconciliation

Error OperationOutcome that the updated DocumentReference references not the same patient

MHD OperationOutcome DocumentReference udpate error unmodifiable metadata

Error OperationOutcome that the updated DocumentReference changed unmodifiable metadata

MHD Provide Document Bundle Response for MedicationCard

MHD Provide Document Bundle Response for MedicationCard

MHD Provide Document Bundle for MedicationCard

MHD Provide Document Bundle for MedicationCard

MHD SubmissionSet (List) for MedicationCard

Example SubmissionSet for a MedicationCard

PDQm Match response message

CH PDQm Match response message example result for Franz Muster, 27.1.1955

PDQm Match response message too many results

CH PDQm Match response message with too many results indication

PDQm OperationOutcome More Attributes Requested Example

An example on the OperationOutcome for indicating which additional attributes are requested to lower the results number.

PDQm Patient Franz Muster (Full URL)

Example Patient

PDQm Provider Organization Gruppenpraxis

Example Organization

PIXm Parameters Query Input

Example Input Parameters Mobile Patient Identifier Cross-reference Query

PIXm Parameters Query Output

Example Output Parameters Mobile Patient Identifier Cross-reference Query

PIXm Patient Feed

Example PIXm Patient for Feed

PPQm Consent for template 201

CH:PPQm Consent for template 201 – Full access for the patient

PPQm Consent for template 202

CH:PPQm Consent for template 202 – Read access in emergency mode

PPQm Consent for template 203

CH:PPQm Consent for template 203 – Default provide level

PPQm Consent for template 301

CH:PPQm Consent for template 301 – Read access for a healthcare professional, without delegation

PPQm Consent for template 302

CH:PPQm Consent for template 302 – Read access for a group of healthcare professionals

PPQm Consent for template 303

CH:PPQm Consent for template 303 – Full access for a representative

PPQm Consent for template 304

CH:PPQm Consent for template 304 – Read access for a healthcare professional, with delegation

PPQm Feed Request Bundle (DELETE)

CH:PPQm Feed Request Bundle for HTTP method DELETE – delete policy sets

PPQm Feed Request Bundle (POST)

CH:PPQm Feed Request Bundle for HTTP method POST – add new policy sets

PPQm Feed Request Bundle (PUT)

CH:PPQm Feed Request Bundle for HTTP method PUT – conditionally update policy sets

PPQm Feed Response Bundle

CH:PPQm Feed Response Bundle

PPQm Retrieve Response Bundle

CH:PPQm Retrieve Response Bundle

mCSD Find Matching Care Services Response Bundle

An example of ITI-90 response Bundle in the profile CH mCSD

mCSD Organization Community A

An example of CHmCSDOrganization that contains the same information as Community A in the Swiss examples (uid=CommunityA,OU=CHCommunity,DC=CPI,O=BAG,C=ch)

mCSD Organization Praxis P

An example of CHmCSDOrganization that contains the same information as Praxis P in the Swiss examples (uid=CommunityA:00000001001,OU=HCRegulatedOrganization,DC=HPD,O=BAG,C=ch)

mCSD Organization Spital X

An example of CHmCSDOrganization that contains the same information as Spital X in the Swiss examples (uid=CommunityA:00000001000,OU=HCRegulatedOrganization,DC=HPD,O=BAG,C=ch)

mCSD Organization Spital X Dept. 3

An example of CHmCSDOrganization that contains the same information as Spital X, Dept. 3 in the Swiss examples (uid=CommunityA:00000001004,OU=HCRegulatedOrganization,DC=HPD,O=BAG,C=ch)

mCSD Practitioner Dr. Peter Pan

An example of CHmCSDPractitioner that contains the same information as Dr. Peter Pan in the Swiss examples (uid=CommunityA:00000003002,OU=HCProfessional,DC=HPD,O=BAG,C=ch)

mCSD PractitionerRole Dr. Peter Pan at Praxis P

An example of CHmCSDPractitionerRole that contains the same information as Dr. Peter Pan - Praxis P Relationship in the Swiss examples (CN=CommunityA:00000001001,OU=Relationship,DC=HPD,O=BAG,C=ch)

mCSD PractitionerRole Dr. Peter Pan at Spital X Dept. 3

An example of CHmCSDPractitionerRole that contains the same information as Dr. Peter Pan - Spital X, Dept. 3 Relationship in the Swiss examples (CN=CommunityA:00000001004,OU=Relationship,DC=HPD,O=BAG,C=ch)