Api
Søke etter behandlingsplan for en pasient med fnr
Bruk FHIR _search med POST og fnr i body. (Bruk av GET og fnr i URL støttes ikke siden URL typisk logges.)
For å få med refererte ressurser for å slippe ekstra kall, bruk _include=* (se Bundle)
For å kun søke etter aktive behandlingsplaner sett parameter status = active
FHIR søk returner alltid en Bundle
Eksempel på søk etter CarePlan for en pasient
curl --location --request POST '/api/careplan/CarePlan/_search' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'subject:Patient.identifier=13116900216' \
--data-urlencode '_include=*'
Eksempel på søk etter CarePlan med include all og status=active for en pasient
curl --location --request POST 'api/careplan/CarePlan/_search' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'subject:Patient.identifier=13116900216' \
--data-urlencode '_include=*' \
--data-urlencode 'status=active'
Se CurlEksempler for eksempler med langtlevende HelseID token som kan testes.
CRUD operasjoner
Opprett CarePlan
curl --location --request POST '/api/careplan/CarePlan'
--header 'Content-Type: application/json'
--data-raw '{"resourceType":"CarePlan" ...}’
Oppdater CarePlan
curl --location --request PUT '/api/careplan/CarePlan/4bb1d390-884a-46e9-8322-5738c977195c '
--header 'Content-Type: application/json'
--data-raw '{ "resourceType": CarePlan" ...}'
Slett CarePlan
Merk at delete bare gjør en logisk sletting av ressursen, dvs. vil ressursen med historikk fortsatt ligge på serveren, men ved GET på en slettet ressurs vil du få minimalt med data og info om at den er slettet.
curl --location --request DELETE '/api/careplan/CarePlan/41213b8f-9f40-49cd-98a4-50cb50040cf3
Andre operasjoner
Finn CarePlan med identifier
curl --location --request GET /api/careplan/CarePlan?identifier=06cc7729-11d0-4566-8be4-fd694f98b86f'
Finn CarePlan med id
curl --location --request GET /api/careplan/CarePlan/a47c8d31-56e4-4786-8833-09de4faebfad’
Hent Careplan-ressurs for gitt ID med historikk
curl --location --request GET /api/careplan/CarePlan/_history/a47c8d31-56e4-4786-8833-09de4faebfad’
Hent spesifik versjon (1) av Careplan-ressurs for gitt ID
curl --location --request GET /api/careplan/CarePlan/_history/a47c8d31-56e4-4786-8833-09de4faebfad/1’
Bruk av FHIR identifier
Ressurser har to identifikatorer:
- id
- identifier
{
"resourceType": "CarePlan",
"id": "1da6ebc5-66ce-409a-977f-fbd5617d11c1",
"meta": {},
"identifier": [
{
"system": "urn:ietf:rfc:3986",
"value": "103151f9-e4d6-4b89-90ef-031304cc60bd"
}
]
}
id er den unike IDen av typen UUID på denne FHIR-serveren. Du kan hente ressursen i eksemplet over med
GET /api/careplan/CarePlan/a47c8d31-56e4-4786-8833-09de4faebfad
identifier er den unike IDen på tvers av FHIR-servere, og er enten en UUID eller eller en annen type unik identifikator ut i fra hvilket system som er definert. For organisasjoner vil identifier feks. være orgnr, mens for personer vil det være fnr/dnr. Du kan hente ressursen i eksemplet over med
GET /api/careplan/CarePlan?identifier=103151f9-e4d6-4b89-90ef-031304cc60bd
Alle tilgjengelige endepunkter
Endepunkt | Beskrivelse |
---|---|
GET /api/careplan/RESOURCE_TYPE?identifier=IDENTIFIER | Søk på identifier |
GET /api/careplan/RESOURCE_TYPE/RESOURCE_ID | Hent ressurs-id |
GET /api/careplan/RESOURCE_TYPE/RESOURCE_ID/history | Hent ressurs-id med historikk |
GET /api/careplan/RESOURCE_TYPE/RESOURCE_ID/history/RESOURCE_VERSION | Hent spesifik versjon av ressurs med gitt id |
POST /api/careplan/RESOURCE_TYPE | Opprett ressurs |
PUT /api/careplan/RESOURCE_TYPE/RESOURCE_ID | Oppdater ressurs |
DELETE /api/careplan/RESOURCE_TYPE/RESOURCE_ID | Slett ressurs (logisk sletting) |
POST /api/careplan/CarePlan/search | Søk etter CarePlan |
GET /api/careplan/metadata | Hent metadata om FHIR-serveren |
GET /api/careplan/codesystem | Hent alle kodeverk |
GET /api/careplan/codesystem/KODEVERK | Hent alle koder i kodeverk |
GET /api/careplan/codesystem/KODEVERK?code=SØKEORD | Søk etter kode i kodeverk |
GET /api/careplan/consent | Hent samtykke for pasient |
POST /api/careplan/consent | Oppdater samtykke for pasient |
POST /api/careplan/status | Sjekke om pasient har behandlingsplan, og når eventuell plan sist ble endret |
RESOURCE_TYPE vil være en av CarePlan, Condition, Goal eller ServiceRequest