Denne guide har som formål at give et overblik over, hvordan CAVE servicen kaldes.
Guiden indeholder referencer til snitfladebeskrivelser for kald til CAVE servicen.
Dette dokument er henvendt til udviklere og arkitekter der skal anvende CAVE servicen.
Det forventes at læseren har et kendskab til REST services og FHIR standarden, da snitfladen er en REST snitflade og CAVE servicen er en implementering af FHIR standarden via Java HAPI implementeringen.
Dato | Ansvarlig | Beskrivelse |
---|---|---|
5/2-2018 | KvalitetsIT | Initiel version |
Rerence | Beskrivelse |
---|---|
REST | Representational State Transfer |
FHIR | Fast Health Interoperability Resources |
HAPI | HAPI-FHIR - Open Source FHIR implementation in Java |
CAVE servicen udstiller en REST snitflade. Installation af CAVE servicen er lavet så det kun er LAR der kan kalde CAVE servicen.
CAVE servicen er en implemtering af FHIR standarden og API'et er derfor standard FHIR. I snitfladebeskrivelsen er kun beksrevet de dele der er anvendt i forhold til LAR servicen. For yderlige detaljer henvises til FHIR standarden.
Request
For at læse AllergyIntolerance oplsyninger sker det via et HTTP Get kald. En række query parametre udgør søgekriterierne. Parametrene er standard FHIR parametre.
Søgningen sker via patient.identifer og der angives oid for CPR systemet og CPR nr. på den patient der søges data for.
For at få referencerne til patient og recorder med angives include af Patient, PractitionerRole, Practitioner og Organization.
Response
MedicationAllergyIntoleranceReduced | ||
---|---|---|
Elementer | Beskrivelse | Påkrævet |
Id på registreringen. | Ja | |
clinicalStatus | Status på registreringen. Er enten Active, Inactive eller Resolved | Ja |
verificationStatus | Overskrives altid med confirmed af LAR servicen. | Nej |
type | Overskrives altid med allergy af LAR servicen. | Nej |
category | Overskrives altid med medication af LAR servicen. | Nej |
criticality | Kritikalitet af allergien. Er enten low, high eller unnable-to-assess. | Nej |
substance | Substans som allergien drejer sig om. Består af en kode og et system. System kan være oid for ATC kode og koden er så en specifik ATC kode. | Ja |
substanceDescription | Tekstuel beskrivelse af substansen. | Nej |
patient | Patient allergien drejer sig om. Består af en code og et system. Hvor code er værdien (CPR nummer) og system er oid koden for CPR systemet. | |
onsetDateTime | Tidspunkt allergien er identificeret. | Ja |
recorder | Lægefaglig person der har indberettet allergien. Består af en code og system. System er oid koden for autorisationskoder og code er autorsationskoden. | Ja |
recorderDescription | Organisation der har indberettet allergien. Består af en code og system. System er oid for SOR og code er SOR koden. | Ja |
note | Note omkring allergien | Nej |
reaction | Reaktion på allergien. Består af:
| Ja |
RegisterPatientAllergyResponse
Består af ReplyStatus og en liste af MedicationAllergyIntoleranceReduced.
ReplyStatus | ||
---|---|---|
Element | Beskrivelse | Påkrævet |
StatusCode | Status kode på forespørgselen. | Ja |
StatusText | Status tekst svarende til status koden. | Ja |
GetPatientAllergyListRequest
Element | Beskrivelse | Påkrævet |
---|---|---|
patient | Patient der skal forespørges på. Består af en code og et system. Hvor code er værdien (CPR nummer) og system er oid koden for CPR systemet. | Ja |
requesterOrganization | Organization der foretager forespørgslen. Består af en code og en type. Code er organization og type er shak, sor eller ydernummer. | Ja |
consentOverride | Indikation af om der skal foretages værdispring. | Ja |
GetPatientAllergyListResponse
Består af ReplyStatus og en liste af MedicationAllergyIntoleranceReduced.
ReplyStatus | ||
---|---|---|
Element | Beskrivelse | Påkrævet |
StatusCode | Status kode på forespørgselen. | Ja |
StatusText | Status tekst svarende til status koden. | Ja |
MedicationAllergyIntoleranceReduced | ||
---|---|---|
Beskrivelse | Påkrævet | |
Id på registreringen. | Ja | |
clinicalStatus | Status på registreringen. Er enten Active, Inactive eller Resolved | Ja |
verificationStatus | Altid confirmed. | Nej |
type | Altid allergy. | Nej |
category | Altid medication. | Nej |
criticality | Kritikalitet af allergien. Er enten low, high eller unnable-to-assess. | Nej |
substance | Substans som allergien drejer sig om. Består af en kode og et system. System kan være oid for ATC kode og koden er så en specifik ATC kode. | Ja |
substanceDescription | Tekstuel beskrivelse af substansen. | Nej |
patient | Patient allergien drejer sig om. Består af en code og et system. Hvor code er værdien (CPR nummer) og system er oid koden for CPR systemet. | |
onsetDateTime | Tidspunkt allergien er identificeret. | Ja |
recorder | Lægefaglig person der har indberettet allergien. Består af en code og system. System er oid koden for autorisationskoder og code er autorsationskoden. | Ja |
recorderDescription | Organisation der har indberettet allergien. Består af en code og system. System er oid for SOR og code er SOR koden. | Ja |
note | Note omkring allergien | Nej |
reaction | Reaktion på allergien. Består af:
| Ja |
Fast Health Interoperability Resources