Doel
De (FHIR) CapabilityStatement (resource) beschrijft de aangeboden mogelijkheden van een eHealth (FHIR) dienst, waarmee gecommuniceerd wordt.
Een FHIR (Resource) Provider MOET een lijst kunnen tonen, via het metadata
endpoint, van mogelijkheden die ondersteund worden, zoals:
- Resource types
- Formaten
- Interacties
- Search (Zoek) parameters
Zie ook FHIR http://hl7.org/fhir/R4/http.html#capabilities
Referentie
FHIR Specification (v4.0.1: R4 - Mixed Normative and STU). Dit is de huidige gepubliceerde versie. Zie ook: https://www.hl7.org/fhir/capabilitystatement.html.
Koppeltaal 2.0 (draft) profiel van CapabilityStatement
Element | Omschrijving | Card. | Type |
---|
User Stories
- Elke actor kan een CapabilityStatement opvragen bij een FHIR (Resource) Provider. De (anonieme) actor heeft hiervoor geen autorisatie nodig.
- De URL van de Capability Statement is [base]/metadata.
Basis URL (base)
Tijdens de implementatie van de fysieke FHIR-server is de basis-URL standaard https://<dns fhir-server>/fhir. Om meerdere domeinen op één fysieke FHIR-server te kunnen faciliteren (multi tenant), wordt in het pad achter /fhir de naam van het domein opgenomen:
https://<dns fhir-server>/fhir/<domein>
Overige standaard URL's
FHIR-parameter | URL |
SearchParameter | https://<dns fhir-server>/fhir/<domein>/SearchParameter |
OperationDefinition | https://<dns fhir-server>/fhir/<domein>/OperationDefinition |
Parameters voor zoekopdrachten (search) en abonnementen (subscription.criteria)
HTTP Request | Methode | Actie |
---|---|---|
/metadata | Get | Ophalen van de capabiliteit en configuratie van de implementatie en deployment van de FHIR-standaard |
Aandachtspunten bij migratie vanuit Koppeltaal 1.x / DSTU1
Voorbeelden
Aannames en opmerkingen:
RESTful diensten moeten op aanvraag een CapabilityStatement kunnen leveren, waarin staat:
- welke resources en profielen ze ondersteunen en bewerken
- diensten die authenticatie vereisen, moeten een CapabilityStatement retourneren voordat authenticatie en/of autorisatie wordt uitgevoerd
- zoekparameters die een dienst ondersteunt worden gespecificeerd in het resource profiel waarnaar het Capability Statement verwijst
- resource en/of operaties die niet worden vermeld, worden niet ondersteund
De volgende CapabilityStatements zijn voorbeelden.