Hier vindt u alle informatie voor ontwikkelaars
FHIR Document API
API specificaties
FHIR Document API
API specificaties
De Zorgplatform FHIR Document API’s worden gebruikt om (semi) gestructureerde documenten op te vragen. Denk hierbij aan PDF documenten maar ook aan HL7 CDA documenten waaronder de CDA representatie van de Basis Gegevensset Zorg. De FHIR Document API’s vormen een FHIR API op de Zorgplatform XDS infrastructuur.
Bekijk 'FHIR specificaties' voor de specificaties van de FHIR resources.
API specificaties
Policies
Gebruikte standaarden
Request format
Response format
API specificaties
Policies
Gebruikte standaarden
Request format
Response format
Documenten worden in de Zorgplatform Document API gerepresenteerd door een FHIR DocumentManifest, DocumentReference en Binary 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 format
HTTP GET application/fhir+json
De partnerapplicatie verzoekt de Zorgplatform Document API om een document op te sturen conform het Zorgplatform resources protocol. Het workflow-id in het token dient overeen te komen met de workflow waarvoor deze documenten zijn aangemeld. Dit kan een (impliciete) search zijn of een opvraging op basis van een resource-id.
Response format
application/fhir+json
Het resultaat van een impliciete search is een Bundle met daarin een of meerdere resources.
Policies
Gebruikte standaarden
Request format
Response format
Documenten worden in de Zorgplatform Document API gerepresenteerd door een FHIR DocumentManifest, DocumentReference en Binary resource.
Operaties kunnen uitsluitend worden aangeroepen door een geldig Zorgplatform token mee te geven.
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.
HTTP GET application/fhir+json
De partnerapplicatie verzoekt de Zorgplatform Document API om een document op te sturen conform het Zorgplatform resources protocol. Het workflow-id in het token dient overeen te komen met de workflow waarvoor deze documenten zijn aangemeld. Dit kan een (impliciete) search zijn of een opvraging op basis van een resource-id.
application/fhir+json
Het resultaat van een impliciete search is een Bundle met daarin een of meerdere resources.