Søk etter person(er) med et konkret fornavn og vise antall treff
Søk etter person(er) med et konkret fornavn
Det er mulig til å søke for konkrete personer basert på enkelte kriterier. Dette søket viser til søk på en element som er en del av standard FHIR-profil i Person-objektet
Dersom en vil ha kun antall treff uten å vise alle resultattreff så kan det defineres ved bruk av _summary
-element
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 |
---|---|---|
name |
KARSTEN | En del av navnet som det søkes etter |
_elements |
identifier,name,address,extension | Det kreves dataminimerings _elements for å spesifisere deler av responsen som skal returneres |
_summary |
count | Viser total antall treff i basen, ref offisiell HL7 FHIR dokumentasjon |
REQUEST
Eksempel-spørring forsøker hente detaljer for en konkret relasjon til en konkret person (oppslag på RelatedPerson)
GET /persontjenesten/fhir/Person?name=KARSTEN&_elements=identifier,name&_summary=count 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 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.
{ "resourceType": "Bundle", "type": "searchset", "total": 182, "id": "ad80fb30-d8a0-48c1-b6f4-bc26e67ce9a4" }
Statuscode: 401 Unauthorized
Mulige verdier av `Jwt`-header i responsen:
* No JwtToken
* Invalid JwtToken