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. Nedenstående er det kald LAR servicen laver for at læse de nødvendige oplysninger.
http://localhost/cave/fhir/AllergyIntolerance?patient.identifier=urn%3Aoid%3A1.2.208.176.1.2%7C0101010102&_include=AllergyIntolerance%3Apatient&_include=AllergyIntolerance%3Arecorder&_include%3Arecurse=PractitionerRole%3Apractitioner&_include%3Arecurse=PractitionerRole%3Aorganization
Response
Svart på
AllergyIntolerance | |
---|---|
Element | Beskrivelse |
identifier | |
clinicalStatus | Status på registreringen. Er enten Active, Inactive eller Resolved |
verificationStatus | Altid confirmed da LAR servicen altid sender confirmed. |
type | Altid allergy da LAR servicen altid sender allergy. |
category | Altid medication da LAR servicen altid sender medication. |
criticality | Kritikalitet af allergien. Er enten low, high eller unnable-to-assess. |
code | |
patient | Reference til Patient ressourcen. |
onsetDateTime | Tidspunkt allergien er identificeret. |
recorder | Reference til PractitionerRole ressourcen. PractitionerRole angiver organization og sundhedsfaglig person der har oprettet data. |
note | |
reaction.manifestation | Reaktion på allergien. Består af:
|
reaction.onset | Tidspunkt hvor reaktionen er observeret. |
reaction.severity | Hvor alvorlig reaktionen er. Enten Mild, moderate eller severe. |
PractitionerRole | |
---|---|
Element | Beskrivelse |
Practitioner | Reference til Practitioner ressourcen. |
Organization | Reference til Organization ressourcen. |
Patient | |
---|---|
Element | Beskrivelse |
Identifier | Code og system. System er OID for CPR og code er CPR nummer på patienten. |
Practioner | |
---|---|
Element | Beskrivelse |
Identifier | Code og system. System er OID for autorisationskode og code er autorsiationskode for den sundhedsfaglige person der har oprettet data. |
Organization | |
---|---|
Element | Beskrivelse |
Identifier | Code og system. System er OID for SOR og code er den SOR kode for den organization der har oprettet data. |
Overskrives altid med confirmed af LAR servicen.
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 | OOverskrives altid med confirmed af LAR servicen.verskrives 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
http://localhost/cave/fhir/AllergyIntolerance?patient.identifier=urn%3Aoid%3A1.2.208.176.1.2%7C0101010102&_include=AllergyIntolerance%3Apatient&_include=AllergyIntolerance%3Arecorder&_include%3Arecurse=PractitionerRole%3Apractitioner&_include%3Arecurse=PractitionerRole%3Aorganization