FHIR BgZ API

API Specificaties

FHIR BgZ API

API Specificaties

De Zorgplatform BgZ API faciliteert het uitwisselen van BgZ van patiënten. De BgZ bevat meerdere FHIR resources die opgevraagd kunnen worden. Bekijk de Swagger documentatie om voorbeelden van de FHIR resources te zien, de wijze waarop deze opgehaald kunnen worden en mogelijke foutmeldingen.

Deze API is beschikbaar voor alle aangesloten vertrouwde applicaties.

API Specificaties

Policies
Gebruikte standaarden
Request
Response
Voorbeelden

API Specificaties

Policies
Gebruikte standaarden
Request
Response
Voorbeelden

De BgZ wordt door de BgZ gerepresenteerd door de FHIR AllergyIntolerance, Appointment, Condition, Consent, Coverage, DeviceRequest, DeviceUseStatement, Encounter, Flag, Immunization, ImmunizationRecommendation, MedicationDispense, MedicationRequest, MedicationStatement, NutritionOrder, Observation, Patient, Procedure en ProcedureRequest resource.

Policies

Operaties kunnen uitsluitend worden aangeroepen door een geldig Zorgplatform token mee te geven.

Gebruikte standaarden

HL7 FHIR Om Zorgplatform RESTful APIs aan te roepen, wordt gebruik gemaakt van FHIR interacties (o.a. create, read en update). Zorgplatform ondersteunt de laatste en de één-na-laatste versie van FHIR.
HTTP-Authorization-header Zorgplatform RESTful APIs maken gebruiken van de HTTP-Authorization-header voor authenticatie en autorisatie.
SAML 2.0 Zorgplatform gebruikt uitsluitend SAML 2.0 assertions als security token.
IHE XUA Zorgplatform SAML 2.0 assertions voldoen aan het IHE XUA integration profile.

Request

HTTP GET application/fhir+json

Response

application/fhir+json

Voorbeelden

Bekijk de Swagger documentatie om voorbeelden van de FHIR resources te zien, de wijze waarop deze opgehaald kunnen worden en mogelijke foutmeldingen.