Et enkelt oppslag for Person
Oppslag på Person ved bruk av Person.id
-element, representert med GUID i Persontjenesten. Denne GUID er ikke permanent identifikator for FHIR-resursen, den kan endre seg over tid fra FHIR-server til FHIR-server.
OBS! De som konsumerer tjenesten skal ikke binde seg fast til denne element, det er server-intern for Persontjenesten.
Enkel sjekkliste:
- sjekk at
Authorization
-detaljer er tilstedet (Oauth2.0 - HelseID) - sjekk at nødvendige headers
Content-Type
ogAccept
er definert - sjekk at
_elements
-parameter er definert
HEADERS
Header | Eksempel på verdi | Beskrivelse |
---|---|---|
Accept |
application/fhir+xml;fhirVersion=4.0 | Accept -header spesifiserer formatet av responsen (JSON/XML) |
Content-Type |
application/fhir+xml;fhirVersion=4.0 | Content-Type -header kreves ved request |
Authorization |
"Bearer <jwt_token>" | En Autorization -header med gyldig JWT-token fra HelseID |
PARAMS
Parameter | Eksempel på verdi | Beskrivelse |
---|---|---|
_elements |
identifier,name,address,extension | Det kreves dataminimerings _elements for å spesifisere deler av responsen som skal returneres |
Request
Eksempel-spørring forsøker hente detaljer for en konkret person (oppslag på Person)
GET /persontjenesten/fhir/Person/f0de16a9-ad9e-49f9-b2b0-875d197028e0?_elements=identifier,name,address,extension HTTP/1.1
Host: api.et.grunndata.helsepunkt.no
Accept: application/fhir+json; fhirVersion=4.0
Content-Type: application/fhir+xml:fhirVersion=4.0
Respons
Statuscode: 200 OK
Det returneres kun 1 konkret person identifisert med Person.id
(NB! Person.id
=\= Person.identifier
).
Alle respons som inneholder Person.meta.tag
-element i metadata med kodeverdi "SUBSETTED" informerer om at resultatet er dataminimert.
Dersom responsen inneholder Person.meta.security
-element i metadata er det indentifikasjon om at person har mest sansynligvis adressebeskyttelse.
{ "resourceType": "Person", "meta": { "profile": [ "http://ehelse.no/fhir/StructureDefinition/gd-Person" ], "versionId": "a6c7825c-a99e-4ae8-afd1-5bd9c7c97037", "lastUpdated": "2021-01-11T05:06:36.860+00:00", "tag": [ { "system": "http://hl7.org/fhir/v3/ObservationValue", "code": "SUBSETTED" } ] }, ... "id": "f0de16a9-ad9e-49f9-b2b0-875d197028e0" }
Statuscode: 401 Unauthorized
Mulige verdier av `Jwt`-header i responsen:
* No JwtToken
* Invalid JwtToken
Statuscode: 404 Not Found
Dersom ingen person med tilhørende Person.id
er funnet så returneres det HTTP-404 Not Found
Statuscode: 410 Gone
Dersom ingen person med tilhørende Person.id
ikke lenger er tilgjengelig så returneres det HTTP-410 Gone