Et enkelt oppslag for RelatedPerson

Oppslag på RelatedPerson ved bruk av RelatedPerson.id-element, representert med GUID i Persontjenesten. Denne GUID er ikke permanent identifikator for resursen og 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 og Accept 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 relasjon til en konkret person (oppslag på RelatedPerson)

GET /persontjenesten/fhir/RelatedPerson/99c24bf8-c061-48f8-8479-20512145576f?_elements=id,identifier,name,relationship,patient HTTP/1.1
Host: api.et.grunndata.helsepunkt.no
Accept: application/fhir+json; fhirVersion=4.0
Content-Type: application/fhir+json; fhirVersion=4.0
Respons
Statuscode: 200 OK

Det returneres maksimalt 1 konkret relasjon, identifisert med RelatedPerson.id.

Alle respons som inneholder RelatedPerson.meta.tag-element i metadata med kodeverdi "SUBSETTED" informerer om at resultatet er dataminimert.

RelatedPerson.identifier-element identifiserer den personen som den identifiserte har relasjon til, kan være representert med Person.id eller Person.identifier.

RelatedPerson.patient-element identifiserer som eier relasjon, dvs at den person har en rolle som * til den relaterte personen.

Eksempel på svar:

{
"resourceType": "RelatedPerson",
"meta": {
  "profile": [
    "http://ehelse.no/fhir/StructureDefinition/gd-RelatedPerson"
  ],
  "versionId": "787af113-6738-4fb6-9ee3-ca3bbb2ff163",
  "lastUpdated": "2021-01-06T21:48:38.509+00:00",
  "tag": [
    {
      "system": "http://hl7.org/fhir/v3/ObservationValue",
      "code": "SUBSETTED"
    }
  ]
},
"identifier": [
  {
    "system": "urn:oid:2.16.578.1.12.4.1.4.1",
    "value": "22110852030"
  }
],
"patient": {
  "reference": "https://api.et.grunndata.helsepunkt.no/persontjenesten/fhir/Person/793bd32a-6145-49dd-96c2-619994e1c1e3"
},
...
"id": "99c24bf8-c061-48f8-8479-20512145576f"
}



Statuscode: 401 Unauthorized

Mulige verdier av `Jwt`-header i responsen:
 * No JwtToken
 * Invalid JwtToken

Statuscode: 404 Not Found

Dersom ingen relasjon med tilhørende RelatedPerson.id er funnet så returneres det HTTP-404 Not Found

Statuscode: 410 Gone

Dersom ingen relasjon med tilhørende RelatedPerson.id ikke lenger er tilgjengelig på serveren så returneres det HTTP-410 Gone