Søk etter flere personer samtidig ved bruk av identifikator
Søke på en konkret person identifisert med personidentifikator (Person.identifier
)
OBS! Søk med personidentifikator er tillatt kun for POST-kall, den kan ikke spesifiseres som en del av GET-kall i URL.
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 - sjekk at resultatsettet
Bundle
for potensielleOperationOutcome
med advarsler
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 |
BODY urlencoded
Parameter | Eksempel på verdi | Beskrivelse |
---|---|---|
identifier |
<pid_1>,<pid_2> | Personidentifikator (PID) som er fødselsnummer, D-nummer eller hjelpenummer |
REQUEST
Eksempel-spørring forsøker hente detaljer for en konkret relasjon til en konkret person (oppslag på RelatedPerson)
POST /persontjenesten/fhir/Person/_search?_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
identifier=01077203660,16099901326
RESPONS
Statuscode: 200 OK
Det returneres alle personer som tilfredstiller søkekriteriter er definert i søkeparametere, i denne sammenheng Person.identifier
.
Det blir returnert en Bundle
-ressurs som kan inneholde sammensetning av alle FHIR-ressurser som tilfredstiller søkekriterier.
Element Bundle.total
viser total antall treff i Bundle.entry
. Dersom det er ingen treff så blir verdien satt til 0.
Element Bundle.link
viser til navigasjon til forrige liste, seg selv eller neste side dersom det finnes flere treff enn det som er definert
Alle respons i Bundle.entry
som inneholder Person.meta.tag
-element i metadata med kodeverdi "SUBSETTED" informerer om at resultatet er dataminimert.
Dersom ressursen i Bundle.entry
inneholder Person.meta.security
-element i metadata er det indentifikasjon om at person har mest sansynligvis adressebeskyttelse.
{ "resourceType": "Bundle", "type": "searchset", "timestamp": "2021-01-26T14:02:42.610+01:00", "meta": { "lastUpdated": "2021-01-26T14:02:42.610+01:00", "versionId": "6ebf8ff0-213e-43ae-81d8-1383e9817f36" }, "entry": [ { "fullUrl": "https://api.et.grunndata.helsepunkt.no/persontjenesten/fhir/Person/793bd32a-6145-49dd-96c2-619994e1c1e3", "search": { "mode": "match" }, "resource": { "resourceType": "Person", "meta": { "profile": [ "http://ehelse.no/fhir/StructureDefinition/gd-Person" ], "versionId": "c313c3ea-f134-4322-9b6b-2ddf63ed4b84", "lastUpdated": "2021-01-11T15:50:03.765+00:00", "tag": [ { "system": "http://hl7.org/fhir/v3/ObservationValue", "code": "SUBSETTED" } ] }, ... "id": "793bd32a-6145-49dd-96c2-619994e1c1e3" }, { "fullUrl": "https://api.et.grunndata.helsepunkt.no/persontjenesten/fhir/Person/f59834ea-242e-4f4b-a165-2a3d083fb314", "search": { "mode": "match" }, "resource": { "resourceType": "Person", "meta": { "profile": [ "http://ehelse.no/fhir/StructureDefinition/gd-Person" ], "versionId": "b6f2e36b-ef9e-4d5c-ba6a-58d30446002b", "lastUpdated": "2021-01-11T05:06:36.948+00:00", "tag": [ { "system": "http://hl7.org/fhir/v3/ObservationValue", "code": "SUBSETTED" } ] }, } ... } } ], "total": 2, "link": [ { "relation": "self", "url": "https://api.et.grunndata.helsepunkt.no/persontjenesten/fhir/Person/_search?_sort=-_lastUpdated&_count=10&_skip=0&_elements=extension,identifier,name,address" } ], "id": "7ec5ae68-bac7-4e6e-9ddd-52198d047c6a" }
Statuscode: 401 Unauthorized
Mulige verdier av `Jwt`-header i responsen:
* No JwtToken
* Invalid JwtToken