Page History
...
Body er defineret som et element af typen treatmentRelationRequestBody, der er en complexType indeholdende en række felter, er specificeret i
"common/src/main/resources/xsd/"
Frem for at læse disse foreslås det at studere eksemplet på en korrekt forespørgsel i
"doc/brs/bilag/requests-and-responses/"
En korrekt forespørgsel skal indeholde informationer om følgende:
treatmentRelationRequestBody | |
|---|---|
Elementer | Beskrivelse |
OrganisationIdentifier | Organisationen inden for hvilken relationen skal findes. Feltet er struktureret og kan indeholde et sks, ydernummer eller EAN-nummer. |
PatientCpr | Patientens cpr-nummer. |
HealthProfessionalCpr | Behandlers cpr-nummer. |
RelationLookupTimeInterval | Tidsinterval inden for hvilket behandleren har foretaget opslaget. Kan f.eks. være validetsperioden for behandlerens ID-kort. |
TimeLimit | Udløbstidspunkt for opfølgningen efter hvilket der skal oprettes en notifikation, hvis de angivne kriterier ikke er opfyldt (se AcceptableRelations nedenfor). |
ExternalReferenceId | Ikke obligatorisk. Et id der vil blive brugt ved returnering af en eventuel notifikation. |
QueryableCvr | CVR nummer der skal have adgang til en eventuel efterfølgende notifikation. |
AcceptableRelations | En liste af acceptable relationer (f.eks. "A+, A, B"). |
FollowupRelations | En liste af relationer der, i tilfælde af at ingen acceptable relationer forefindes (se ovenfor), vil give anledning til en opfølgning, f.eks. "D, E". Ønskes der opfølgning på alle kategorier udover dem der er angivet i AcceptableRelations sættes værdien til "ALL". |
AuthorisationIdentifier | Autorisationskode for den behandleren. |
ServiceProvider | Tekststreng indeholdende navnet på serviceudbyderen (f.eks. FMK). Bruges til logformål. |
...
Operationen "treatmentRelation" returnerer et treatmentRelationResponse, der opfylder DGWS. Det vil sige, at det har en wsse og en medcom header. Selve svaret er defineret som et treatmentRelationResponseBody som defineret i
"common/src/main/resources/xsd/"
Svaret indeholder information om:
treatmentRelationResponse | |
|---|---|
Elementer | Beskrivelse |
SufficientRelation | Om der var tilstrækkelig relation til at foretage opslaget ("beslutningen" foretages af BRS på basis af værdien i AcceptableRelations angivet i kaldet). |
ActualRelations | Hvad de faktiske relationer er (på baggrund af kendt data fra eksterne registre). |
FollowupOrdered | Om en opfølgning er bestilt eller ej. |
UniqueReferenceId | Et unikt referenceid, der kan bruges til at koble forespørgslen sammen med en eventuel senere notifikation. |
ExternalReferenceId | Værdien af feltet ExternalReferenceId fra forespørgslen. Hvis et sådant ikke var specificeret returneres et nyt generet id, forskelligt fra UniqueReferenceId. |
...
Body er defineret som et element af typen notificationQueryRequestBody, der er en complexType indeholdende en række felter, der er specificeret i
"common/src/main/resources/xsd/notification/"
Frem for at læse denne foreslås det at studere eksemplet på en korrekt forespørgsel i
"doc/bilag/requests-and-responses/"
En korrekt forespørgsel skal indeholde informationer om følgende:
notificationQueryRequestBody | |
|---|---|
Elementer | Beskrivelse |
Type | Typen af notifikationen. For en behandlingsrelation vil værdien være "BRS". |
SerialNumber | Et notifikationserienummer der bruges som afsæt i databasen. Kun notifikationer med et serienummer større end eller lig dette returneres. |
...
Operationen "notificationQuery" returnerer et notificationQueryResponse der opfylder DGWS. Det vil bl.a. sige, at det har en wsse og en medcom header. Selve svaret er defineret som et notificationQueryResponseBody som defineret i
"common/src/main/resources/xsd/notification/"
Svaret indeholder de første 100 notifikationer med serienummer højere end eller lig det der er angivet i forespørgslen. Notifikationerne returneres i sorteret rækkefølge. Hver notifikation indeholder følgende informationer:
notificationQueryResponse | |
|---|---|
Elementer | Beskrivelse |
Type | Typen af notifikationen. Fra BRS version 2.0.1 vil dette altid være "BRS". |
SerialNumber | Serienummer for notifikationen. |
ExternalReferenceId | Det eksterne reference id. Værdien af dette felt hentes fra det oprindelige kald til opsamlingsservicen. |
QueryableCvr | CVR-nummer på den instans der kan læse notifikationen. Matcher det fundet i headeren for notifikationsforespørgslen. |
Payload | Et element der indeholder data for notifikationen. Fra BRS version 2.0.1 vil dette altid være en behandlingsrelation, dvs. typen treatmentRelationAlarm. |
...
| Anchor | ||||
|---|---|---|---|---|
|
treatmentRelationAlarm | |
|---|---|
Elementer | Beskrivelse |
ActualRelations | De faktiske relationer fundet for den pågældende behandler og patient. |
TreatmentRelationFollowup | Opfølgningen der gav anledning til notifikationen. |
...
TreatmentRelationFollowup-elementet er af typen beskrevet i
"common/src/main/resources/xsd/brs/treatmentRelationFollowup.xsd"
Denne indeholder felterne:
treatmentRelationFollowup | |
|---|---|
Elementer | Beskrivelse |
TreatmentRelationFollowupSerialNumber | Serienummeret for den pågældende opfølgning. |
TreatmentRelationRelayerData | Datastruktur med de nødvendige data for at udtrække gældende relationer, se tabellen nedenfor. |
TimeLimit | Tidsgrænse for en relations opståelse. En eventuel notifikation oprettes hvis der efter denne tidsgrænse ikke er opstået en gyldig relation. |
RequestSource | Det komplette kald (treatmentRelationRequestBody) der blev sendt til BRS da opfølgningen blev bestilt. |
ExternalReferenceId | Samme værdi som i det oprindelige svar fra BRS. |
UniqueId | Samme værdi som i det oprindelige svar fra BRS. |
QueryableCvr | CVR-nummer på instansen der har ret til at læse eventuelle notifikationer. |
AcceptableRelations | Relationer der skal være til stede for at opfølgningen slettes uden at give anledning til en notifikation. |
...
Elementet TreatmentRelationRelayerData indeholder følgende data, der er nok til at identificere de kendte relationer mellem en behandler og en patient.
TreatmentRelationRelayerData | |
|---|---|
Elementer | Beskrivelse |
OrganisationIdentifier | Organisationen inden for hvilken relationen skal findes. Feltet er struktureret og kan indeholde et sks, ydernummer eller EAN-nummer. |
PatientCpr | Patientents CPR-nummer. |
HealthProfessionalCpr | Den sundhedsfagliges CPR-nummer. |
RelationLookupTimeInterval | Intervallet inden for hvilket relationen skal forefindes. Vil i første omgang være trukket ud fra id-kortet i den oprindelige treatmentRelationRequest (Intervallet sættes til id-kortets gyldighedsperiode). |
...
Nedenfor ses en liste af typiske fejl der kan forekomme når en service kaldes. Fejl der returneres indeholder en fejlkode samt en fejltekst med yderligere detaljer. Teksten er ikke medtaget i tabellen nedenfor da den kan variere afhængig af hvad der gav anledning til fejlen.
Kode | Betydning |
|---|---|
processing_problem | Som oftest validerings fejl, kan dog også opstå ved en generel fejl i servicen. |
missing_required_header | En sikkerheds eller medcom header mangler i requestet |
security_level_failed | Authentification level som angivet i headeren er ikke tilstrækkelig til at tilgå servicen. |
invalid_idcard | Ugyldigt id-kort. |
expired_idcard | Id-kortet er udløbet. |
not_authorized | Manglende whitelisting (kontakt nsp operatøren for at blive whitelistet) |
...