...
Grensesnitt 10 over (mellomlagring av delvis utfylt skjema på Helsenorge) støttes kun synkront (dvs. gjennom API)
API’er
Alle FHIR API’er på Helsenorge støtter et subset av den fulle spesifikasjonen: http://hl7.org/fhir/http.html
Det skal benyttes HTTPS
Det støttes ikke versjonering av FHIR-ressurser
Klienter kan ikke velge hvilken respons som ønskes ved å benytte “
Prefer Header for HTTP”
. Avhengig av hvilken HTTP operasjon som benyttes, returneres enten hele FHIR-ressursen eller kun resultatet av operasjonen (se under).
Update - HTTP PUT
Klienter kan benytte “Update” for å kreere en ny ressurs på Helsenorge med en ressurs ID bestemt av klienten. Ressurs-ID’en skal være den samme i URL’en og i FHIR-ressursen. ID’en skal være globalt unik (dvs. en GUID). Ressursen kan siden aksesseres i API’er ved angi Type og Id.
Støttede FHIR-ressurs typer:
Task
DocumentReference
Request/response:
HTTP-request:
PUT [base]/[type]/[id]
HTTP-body: En FHIR ressurs av type
[type]
- Ressursens-ID skal være satt og være global unik.HTTP respons:
OK: 201 - created
Feil: 400 - error + FHIR OperationOutcome
Create - HTTP POST
Klienter kan benytte “Create” for å kreere en ny ressurs på Helsenorge. Det er Helsenorge som bestemmer ressurs-ID’en.
Støttede FHR-ressurs typer:
Task
DocumentReference
Request/response:
HTTP-request:
POST [base]/[type]
HTTP-body: En FHIR ressurs av type
[type]
(Dersom ressursen har en ressurs-ID fra før, vil denne endres)HTTP respons:
OK: 201 - created. Ved suksessfull opprettelse av ressursen og påfølgende respons SKAL
Location
headeren være satt inneholdende logisk id , i tillegg returneres den opprettede ressursen i sin helhet.Feil: 400 - error + FHIR OperationOutcome
Transaction - HTTP POST
Støttede FHR-ressurs typer:
Bundle (med Bundle.type = “transaction”)
Task
Questionnaire
QuestionnaireResponse
DocumentReference
Request/response:
HTTP-request:
POST [base]
HTTP-body:
En FHIR ressurs av type
Bundle
(Dersom Bundle har en ressurs-ID fra før, vil denne endres)Hver ressurs i Bundle SKAL etterfølges av hvilken operasjon som skal utføres. Det støttes KUN HTTP PUT, dvs. at alle ressursene i Bundelen må ha en ressurs ID tilordnet av klienten. Denne skal være en GUID.
HTTP respons:
OK: 200 + Bundle med Bundle.type = “transaction-response”
Feil: 400 - error + Bundle med et sett FHIR OperationOutcome
Read - HTTP GET
Støttede FHIR-ressurs typer:
Task
DocumentReference
Questionnaire
QuestionnaireResponse
Request/response:
HTTP-request:
GET [base]/[type]/[id]
HTTP-body: N/A
HTTP respons:
OK: 200 - OK + FHIR-resource of
[type]
with resource-ID[id]
Feil: 404 - Not Found
Search - HTTP GET (med parametere)
Støttede FHIR-ressurs typer:
Task
DocumentReference
Questionnaire
QuestionnaireResponse
Request/response:
HTTP-request:
GET [base]/[type] {?[parameters]}
HTTP-body: N/A
HTTP respons:
200 OK + Bundle med Bundle.type = “
searchset”
med en samling av FHIR ressurser av type[type]
og som tilfredsstiller søkeparameterne. Dersom søket ikke ga noe resultat inneholder Bundelen ingen ressurser.Feil:
401 - Not Authorized
404 - Not Found - Hvis man ikke støtter ressurstypen
Delete - HTTP DELETE
Støttede FHIR-ressurs typer:
DocumentReference
QuestionnaireResponse
Request/response:
HTTP-request:
DELETE [base]/[type]/[id]
HTTP-body: N/A
HTTP respons:
OK: 204 - No Content
Feil: 405 - Method not Allowed