CH EPR FHIR (R4)
4.0.0-ballot - ballot Switzerland flag

This page is part of the CH EPR FHIR (R4) (v4.0.0-ballot: DSTU 4 Ballot 1) 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

Sequence Diagrams

Sample sequence diagrams to illustrate the usage of the generic EPR API and SMART on FHIR options for reading documents as a patient or healthcare professional:

Patient: get document – generic EPR API option

Patient PortalCommunity ComponentsIdPPatientPatientApp GUIApp GUIDocument Consumer(MHD)Document Consumer(MHD)Patient IdentifierCross-referenceConsumerPatient IdentifierCross-referenceConsumerAuthorization Client(IUA)Authorization Client(IUA)Patient IdentifierCross-referenceMangerPatient IdentifierCross-referenceMangerAuthorization Server(IUA)Authorization Server(IUA)Document Responder(MHD)Document Responder(MHD)UserAuthenticationProviderUserAuthenticationProvider[01]read doc[02]GET /.well-known/smart-configuration[03]Conformance statement incl. OAuth 2.1 endpoints[04]Get Access Token[05][ITI-71] Get Access Token Request[Basic access token][06]Authenticate User[07] [08]Authorize App Access[09][ITI-71] Get Access Token Response[Basic access token][10] [11]query MPI-PID and EPR-SPIDfrom MPI using localID and access token[12][ITI-83] Mobile Patient Identifier Cross-referenceQuery [local ID] together with access token[13][ITI-83] Mobile Patient Identifier Cross-referenceQuery Response [MPI-PID, EPR-SPID][14] [15]Get Access Token[16][ITI-71] Get Access Token[Extended access token][17][ITI-71] Get Access Token Response[Extended access token][18] [19]query documents[20]query documents [ITI-67][21] [22] [23]retrieve documents[24]retrieve document [ITI-68][25] [26] [27] 

Healthcare professional: get document – generic EPR API option

Healthcare Professional Portal or Primary SystemCommunity ComponentsIdPHealthcareProfessionalHealthcareProfessionalApp GUIApp GUIDocument Consumer(MHD)Document Consumer(MHD)Patient IdentifierCross-referenceConsumerPatient IdentifierCross-referenceConsumerAuthorization Client(IUA)Authorization Client(IUA)Patient IdentifierCross-referenceMangerPatient IdentifierCross-referenceMangerAuthorization Server(IUA)Authorization Server(IUA)Document Responder(MHD)Document Responder(MHD)UserAuthenticationProviderUserAuthenticationProvider[01]read doc[02]GET /.well-known/smart-configuration[03]Conformance statement incl. OAuth 2.1 endpoints[04]Get Access Token[05][ITI-71] Get Access Token Request[Basic access token][06]Authenticate User[07] [08]Authorize App Access[09][ITI-71] Get Access Token Response[Basic access token][10] [11]query MPI-PID and EPR-SPIDfrom MPI using localID and access token[12][ITI-83] Mobile Patient Identifier Cross-referenceQuery [local ID] together with access token[13][ITI-83] Mobile Patient Identifier Cross-referenceQuery Response [MPI-PID, EPR-SPID][14] [15]Get Access Token[16][ITI-71] Get Access Token[Extended access token][17][ITI-71] Get Access Token Response[Extended access token][18] [19]query documents[20]query documents [ITI-67][21] [22] [23]retrieve documents[24]retrieve document [ITI-68][25] [26] [27] 

Patient: get document – SMART on FHIR option (EHR Launch)

Patient PortalSMART on FHIR AppCommunity ComponentsIdPPatientPatientApp GUIIUA Authorization ClientApp GUIIUA Authorization ClientAuthorization Client(IUA)Authorization Client(IUA)Patient IdentifierCross-referenceConsumerPatient IdentifierCross-referenceConsumerApp GUIIUA Authorization ClientApp GUIIUA Authorization ClientDocument Consumer(MHD)Document Consumer(MHD)Authorization Server(IUA)Authorization Server(IUA)Patient IdentifierCross-referenceMangePatient IdentifierCross-referenceMangeDocument Responder(MHD)Document Responder(MHD)UserAuthenticationProviderUserAuthenticationProvider[01]read doc[02]GET /.well-known/smart-configuration[03]Conformance statement incl. OAuth 2.1 endpoints[04]Get Access Token[05][ITI-71] Get Access Token Request[Basic access token][06]Authenticate User[07] [08]Authorize App Access[09][ITI-71] Get Access Token Response[Basic access token][10] [11]query MPI-PID and EPR-SPIDfrom MPI using localID and access token[12][ITI-83] Mobile Patient Identifier Cross-referenceQuery [local ID] together with access token[13][ITI-83] Mobile Patient Identifier Cross-referenceQuery Response [MPI-PID, EPR-SPID][14] [15]launch app[16]GET /.well-known/smart-configuration[17]Conformance statementincl. OAuth 2.1 endpoints[18][ITI-71] Get Access Token[Extended access token][19][ITI-71] Get Access Token Response[Extended access token][20]query documents[21]query documents [ITI-67][22] [23] [24]retrieve document[25]retrieve document [ITI-68][26] [27] [28] [29] 

Healthcare professional: get document – SMART on FHIR option (EHR Launch)

Healthcare Professional Portal or Primary SystemSMART on FHIR AppCommunity ComponentsIdPHealthcareProfessionalHealthcareProfessionalApp GUIIUA Authorization ClientApp GUIIUA Authorization ClientAuthorization Client(IUA)Authorization Client(IUA)Patient IdentifierCross-referenceConsumerPatient IdentifierCross-referenceConsumerApp GUIIUA Authorization ClientApp GUIIUA Authorization ClientDocument Consumer(MHD)Document Consumer(MHD)Authorization Server(IUA)Authorization Server(IUA)Patient IdentifierCross-referenceMangePatient IdentifierCross-referenceMangeDocument Responder(MHD)Document Responder(MHD)UserAuthenticationProviderUserAuthenticationProvider[01]read doc[02]GET /.well-known/smart-configuration[03]Conformance statement incl. OAuth 2.1 endpoints[04]Get Access Token[05][ITI-71] Get Access Token Request[Basic access token][06]Authenticate User[07] [08]Authorize App Access[09][ITI-71] Get Access Token Response[Basic access token][10] [11]query MPI-PID and EPR-SPIDfrom MPI using localID and access token[12][ITI-83] Mobile Patient Identifier Cross-referenceQuery [local ID] together with access token[13][ITI-83] Mobile Patient Identifier Cross-referenceQuery Response [MPI-PID, EPR-SPID][14] [15]launch app[16]GET /.well-known/smart-configuration[17]Conformance statementincl. OAuth 2.1 endpoints[18][ITI-71] Get Access Token[Extended access token][19][ITI-71] Get Access Token Response[Extended access token][20]query documents[21]query documents [ITI-67][22] [23] [24]retrieve document[25]retrieve document [ITI-68][26] [27] [28] [29]