RIVO-Noord Zorgviewer Implementation Guide
1.23.0 - CI build

RIVO-Noord Zorgviewer Implementation Guide, published by RIVO-NN HL7NL. This guide is not an authorized publication; it is the continuous build for version 1.23.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/RIVO-Noord/zorgviewer-ig/ and changes regularly. See the Directory of published versions

## Gebruikerscontext Design

Na authenticatie in het eigen systeem (Zorgviewer Host) van de zorgverlener kan de zorgviewer worden opgestart. Daarvoor zijn bepaalde attributen nodig (1ste tabel) die al dan niet met een mapping of lookup worden omgezet in minimaal vereiste attributen i.h.k.v. wettelijke Logging bij het bevragen van de andere Bronsystemen (2de tabel). De 1ste tabel toont de attributen ontvangen door de Zorgviewer van de Zorgviewer Host en de 2de tabel toont de attributen zoals ze worden meegestuurd bij bevragen bronsystemen.

### Opstarten zorgviewer: Summary Table

In onderstaande tabel hebben we voor alle methoden de verschillende definities van attributen naast elkaar gezet en waar ze te vinden zijn in de verschillende standaarden (SAML, SMART-on-FHIR, FHIR).

Item | FHIR Path | Ideaal (SAML+FHIR) | Sanday (SAML) | Nexus (SAML) | Chipsoft Zorgplaform (SAML+FHIR) | VIPLive (SAML) | Epic (SMART-on-FHIR) | Example
--- | --- | --- | --- | --- | --- | --- | --- | ---
Workflow ID nvt |  | nvt | nvt | nvt | http://sts.zorgplatform.online/ws/claims/2017/07/workflow/workflow-id | nvt | nvt | `a84f5229-c804-4627-8b80-489ae3ed6a51`
Practitioner ID | Practitioner.identifier | `Subject/NameID` | `Subject/NameID` | `Subject/NameID` | `Subject/NameID` | `Subject/NameID` | Practitioner read adhv `token.practitioner` | `177578`
Practitioner Name Initials | Practitioner.name.given[extension=IN] | - | - | `professional.initials` | - | `professional.initials` | zie FHIR Path | `L.`
Practitioner Family Name | Practitioner.name.family | - | - | `professional.family_name` | - | `professional.family_name` | zie FHIR Path | `Arts`
Practitioner Name | Practitioner.name | http://schemas.xmlsoap.org/ws/2005/05/identity/claims/name | `zorgverlener.volledigenaam` | concat initials + family_name | http://schemas.xmlsoap.org/ws/2005/05/identity/claims/name | - | zie FHIR Path | `L. Arts`
Practitioner Role | PractitionerRole.code[system=http://snomed.info/sct] | urn:oasis:names:tc:xacml:2.0:subject:role | translate Functie omschrijving1 | urn:oasis:names:tc:xacml:2.0:subject:role translate RolCodeNL2 | urn:oasis:names:tc:xacml:2.0:subject:role translate RolCodeNL2 | urn:oasis:names:tc:xacml:2.0:subject:role SNOMED CT | translate Epic Provider Type3 PractitionerRole read adhv `token.practitioner` | `code=62247001 display=huisarts system=http://snomed.info/sct` of `urn:oid:2.16.840.1.113883.2.4.15.111.01.000` voor rolcode `01.000`
Organization OID | Practitioner.meta[extension=source] | urn:oasis:names:tc:xspa:1.0:subject:organization-id | lookup4 | urn:oasis:names:tc:xspa:1.0:subject:organization-id | urn:oasis:names:tc:xspa:1.0:subject:organization-id | `organization-id` | zie FHIR Path | `2.16.840.1.113883.2.4.3.8`
Organization URA | Practitioner.meta[extension=source][system=http://fhir.nl/fhir/NamingSystem/ura] | - | `zorgverlener.praktijkURA` | - | - | `professional.org.ura` | - | `http://fhir.nl/fhir/NamingSystem/ura\|12345678`
Patient BSN | Patient.identifier[system=bsn] | urn:oasis:names:tc:xacml:1.0:resource:resource-id | `patient.BSN` | `client.bsn` | urn:oasis:names:tc:xacml:1.0:resource:resource-id | `client.bsn` | Patient read adhv `token.patient` zie FHIR Path | `999911120`
Patient FHIR ID | Patient.id | Patient search w/ identifier={BSN} zie FHIR Path | request5 | - | `patient-fhir-id` uit Task.reference read adhv `workflow-id` | - | `token.patient` | `9819C39260647B5DE61609CDF1FA1C`
Patient Name Initials | Patient.name.given[extension=IN] | zie FHIR Path | - | `client.initials` | Patient.read adhv `patient-fhir-id` / zie FHIR Path | `client.initials` | zie FHIR Path | `J.`
Patient Family Name | Patient.name.family | zie FHIR Path | - | `client.family_name` | zie FHIR Path | `client.family_name` | zie FHIR Path | `Fictief`
Patient Name | Patient.name | zie FHIR Path | `patient.volledigenaam` | - | zie FHIR Path | - | zie FHIR Path | `J. Fictief`
Patient Birthdate | Patient.birthDate | zie FHIR Path | `patient.geboortedatum` | `client.birthdate` | zie FHIR Path | `client.birthdate` | zie FHIR Path | `19700101`

### Verkrijgen bronsysteem access token

> N.B. Deze IG bouwt op SMART-on-FHIR 1.0.0 ivm FHIR STU3 en Scopes notatie. De bijbehorende backend authenticatie is gespecificeerd in Bulk Data Access FHIR specificaties. SMART-on-FHIR 2.0 brengt eea weer samen, maar upgrade ook de Scopes en de FHIR versie naar R4. Daarom blijven wij voor MVP2 bij de 1.0.0 versie.

> N.B. Vanuit de WEGIZ wordt de TA Notified Pull een eis. Richting de toekomst zullen de verschillende bronsystemen hier naartoe werken. Naast SMART-on-FHIR zal de TA Notified Pull de voorkeur standaard zijn. Tot die tijd moeten we meerdere vormen ondersteunen, zie de Summary Tables.

Hier passen we de request access token flow toe van de Bulk Data Access Backend authenticatie specificaties. Daarnaast ivm NEN 7513 logging requirement moet het bronsysteem de vragende organisatie weten. De vragende organisatie is de organisatie van de geauthenticeerde gebruiker van de Zorgviewer. De IHE IUA standaard beschrijft de attribuut naam die hiervoor gebruikt dient te worden in de authentication JWT die mee gaat naar de access token request. Dit is ook zoals LSP/VZVZ dit doet.

    { "iss": "...",
      "sub": "...",
      "exp": "...",
      (optioneel) "subject_organization": "UMCG",
      "subject_organization_id": "urn:oid:2.16.840.1.113883.2.4.3.8"
    }

### Bevragen bronsysteem: Summary Table

In onderstaande tabel hebben we voor alle methoden de verschillende definities van attributen naast elkaar gezet en waar ze te vinden zijn in de verschillende standaarden (OAuth, SMART-on-FHIR, TA Notified Pull).

Item | Generiek (HTTP-Header) | TA Notified Pull | Sanday (OAuth) | Nexus (OAuth) | Chipsoft Zorgplaform (OAuth) | VIPLive (OAuth) | Epic (SMART-on-FHIR) | Example | FHIR Path
--- | --- | --- | --- | --- | --- | --- | --- | --- | ---
PurposeOfUse |  | FHIR Task.code | nvt | nvt | urn:oasis:names:tc:xspa:1.0:subject:purposeofuse | nvt | nvt | `TREATMENT` | nvt
Workflow ID |  | FHIR Task.identifier | nvt | nvt | http://sts.zorgplatform.online/ws/claims/2017/07/workflow/workflow-id | nvt | nvt | `a84f5229-c804-4627-8b80-489ae3ed6a51` | nvt
Patient BSN |  | auth_token.patient | via $match | auth_token.patient | urn:oasis:names:tc:xacml:1.0:resource:resource-id | client.bsn | auth_token.patient | `999911120` | Patient.identifier[system=BSN]
Practitioner ID | X-ZV-Subject-Id | auth_token.user_id | ?? | auth_token.user_id | Subject/NameID | Subject/NameID | auth_token.subject_id en HTTP-Header AORTA-ID usr | `177578` | Practitioner.identifier
Practitioner Role | X-ZV-Subject-Role | auth_token.user_role | ?? | auth_token.user_role | urn:oasis:names:tc:xacml:2.0:subject:role | urn:oasis:names:tc:xacml:2.0:subject:role | auth_token.subject_role en HTTP-Header AORTA-ID rol | `code=62247001 display=huisarts system=http://snomed.info/sct` | Practitioner.qualification[system=http://snomed.info/sct]
Practitioner Name |  |  | ?? |  | http://schemas.xmlsoap.org/ws/2005/05/identity/claims/name | professional.initials + professional.family_name | auth_token.subject_name | `L. Arts` | Practitioner.name
Requesting Organization (OID) | X-ZV-Subject-Organization-Id | auth_token.sub | context-requester-org-id |  | urn:oasis:names:tc:xspa:1.0:subject:organization-id | urn:oasis:names:tc:xspa:1.0:subject:organization-id | auth_token.subject_organization_id en HTTP-Header AORTA-ID org | `2.16.528.1.1007.3.3.15123` | Practitioner.meta[extension=source]
Requesting Organization (URA) | X-ZV-Subject-Organization-Ura |  |  | auth_token.sub |  |  | auth_token.subject_organization_ura | `12345678` | Practitioner.meta[extension=source] system=http://fhir.nl/fhir/NamingSystem/ura
Requesting Organization (Role) |  |  |  | auth_token.sub_role |  |  |  | `H1` huisartsinstelling | system=http://nictiz.nl/fhir/NamingSystem/organization-type
Target Organization (AGB) |  |  | context-target-org-id |  |  |  |  | system=http://fhir.nl/fhir/NamingSystem/agb-z `01010813` |
Correlation ID | X-Correlation-Id |  | ⇐ | ⇐ | ⇐ | ⇐ | HTTP-Header AORTA-ID cid | NaN0-1D-12 `H54f_8b9d6bC` | nvt
Request ID | X-Request-Id |  | ⇐ | ⇐ | ⇐ | ⇐ | HTTP-Header AORTA-ID rid | NaN0-1D-12 `1b9d6bCd-bBf` | nvt
Context | X-ZV-Context |  | ⇐ | ⇐ | ⇐ | ⇐ | ⇐ | zie boven |

1. Omzetten naar SNOMED CT adhv `zorgverlener.functie.omschrijving` in ConceptMap-sanday ↩

2. Omzetten naar SNOMED CT in ConceptMap-rolcodenl ↩ ↩2

3. Omzetten naar SNOMED CT in ConceptMap-epic-rolcode ↩

4. Opzoeken OID adhv `zorgverlener.praktijkURA` ↩

5. Adhv request Patient/$match (optie 3) ↩