Hier vindt u alle informatie voor ontwikkelaars
Workflow API
API specificaties
Workflow API
API specificaties
De Zorgplatform Workflow API faciliteert het gebruik van workflows als contract tussen partijen over de gegevens die uitgewisseld mogen worden voor een werkproces. Workflows worden in de Zorgplatform Workflow API gerepresenteerd door een of meerdere FHIR Task resources. Via de Workflow API worden workflows die via een aangesloten vertrouwde partij zijn gestart, gepubliceerd. Veel FHIR API’s, zoals de Document API en de Administration API, kunnen worden gebruikt om de aan een Task geassocieerde gegevens en documenten op te vragen.
Deze API is beschikbaar voor alle aangesloten vertrouwde applicaties.
API specificaties
Policies
Gebruikte standaarden
Request format
Response format
Voorbeeld
API specificaties
Policies
Gebruikte standaarden
Request format
Response format
Voorbeeld
Workflows worden in de Zorgplatform Workflow API gerepresenteerd door een of meerdere FHIR Task resources. Bekijk 'FHIR specificaties' voor de specificaties van de FHIR Task resource.
De specificaties over Workflows zijn ook als PDF beschikbaar ter download.
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
HTTP PUT application/fhir+json
De partnerapplicatie verzoekt de Zorgplatform Workflow service om de Task resource op te sturen of te wijzigen conform het Zorgplatform Resource protocol. Het workflow-ID in het token dient overeen te komen met het workflow-ID wat gebruikt wordt als identifier van de Task resource.
Response format
application/fhir+json
De exacte inhoud van de FHIR Task resource is afhankelijk van de use case. Bijvoorbeeld in de use case ‘thuismonitoring’, zal alleen de referentie naar de patiënt aanwezig zijn (in het element ‘for’). In de use case ‘verwijzing’ zal een referentie naar de resource ‘Practitioner’ toegevoegd zijn (in het element ‘owner’). Enkele elementen in de FHIR Task resource zijn wel verplicht in iedere use case. Bij andere use cases zal besproken worden welke resources toegevoegd of weggelaten moeten worden, mits dit past in de FHIR structuur.
Voorbeeld
{
"resourceType":"Task",
"id":"123",
"meta":{
"profile":[
"http://hl7.org/fhir/StructureDefinition/Task"
]
},
"identifier":[
{
"system":"http://hl7.org/fhir/StructureDefinition/oid",
"value":"urn:oid:1.3.6.1.4.1.19376.1.5.3.1.5.2"
}
],
"status":"in-progress",
"intent":"order",
"code":{
"text":"Test"
},
"description":"Test",
"for":{
"reference":"Patient/[ID]",
"display":"Patient reference for patient resource with name 'PATIENT'."
},
"authoredOn":"[datetime]",
"lastModified":"[datetime]"
}
Policies
Gebruikte standaarden
Request format
Response format
Voorbeeld
Workflows worden in de Zorgplatform Workflow API gerepresenteerd door een of meerdere FHIR Task resources. Bekijk 'FHIR specificaties' voor de specificaties van de FHIR Task resource.
De specificaties over Workflows zijn ook als PDF beschikbaar ter download.
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
HTTP PUT application/fhir+json
De partnerapplicatie verzoekt de Zorgplatform Workflow service om de Task resource op te sturen of te wijzigen conform het Zorgplatform Resource protocol. Het workflow-ID in het token dient overeen te komen met het workflow-ID wat gebruikt wordt als identifier van de Task resource.
application/fhir+json
De exacte inhoud van de FHIR Task resource is afhankelijk van de use case. Bijvoorbeeld in de use case ‘thuismonitoring’, zal alleen de referentie naar de patiënt aanwezig zijn (in het element ‘for’). In de use case ‘verwijzing’ zal een referentie naar de resource ‘Practitioner’ toegevoegd zijn (in het element ‘owner’). Enkele elementen in de FHIR Task resource zijn wel verplicht in iedere use case. Bij andere use cases zal besproken worden welke resources toegevoegd of weggelaten moeten worden, mits dit past in de FHIR structuur.
{
"resourceType":"Task",
"id":"123",
"meta":{
"profile":[
"http://hl7.org/fhir/StructureDefinition/Task"
]
},
"identifier":[
{
"system":"http://hl7.org/fhir/StructureDefinition/oid",
"value":"urn:oid:1.3.6.1.4.1.19376.1.5.3.1.5.2"
}
],
"status":"in-progress",
"intent":"order",
"code":{
"text":"Test"
},
"description":"Test",
"for":{
"reference":"Patient/[ID]",
"display":"Patient reference for patient resource with name 'PATIENT'."
},
"authoredOn":"[datetime]",
"lastModified":"[datetime]"
}