Versions Compared

Old Version 15

changes.mady.by.user Unknown User (jpe@kvalitetsit.dk)

Saved on

compared with

New Version 16

changes.mady.by.user Lene Andersen

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Denne guide har som formål at give et overblik over, hvordan LAR servicen kaldes.
Guiden indeholder referencer til snitfladebeskrivelser for kald til LAR servicen.

...

Dette dokument er henvendt til udviklere og arkitekter, der skal anvende LAR servicen. 

...

LAR service udstiller en SOAP snitflade. SOAP snitfladen overholder DGWS. Det betyder, at der skal være en gyldig security og medcom header. Disse to headers er ikke beskrevet i snitfladebeskrivelsen, da disse er en del af DGWS. 

SOAP snitfladen udstiller to SOAP actions og det er disse, der er beskrevet i snitfladebeskrivelse afsnittet.

...

Snitfladerne er inspireret af FHIR standarden, og alle elementer hedder, så vidt det er muligt, det samme som i FHIR standarden. 

RegisterPatientAllergy

RegisterPatientAllergyRequest

MedicationAllergyIntoleranceReduced
ElementerBeskrivelsePåkrævet
identifierId på registreringen.JaNej
clinicalStatusStatus på registreringen. Er enten Activeactive, Inactive inactive eller ResolvedresolvedJa
verificationStatusOverskrives altid med confirmed af LAR servicen.Nej
typeOverskrives altid med allergy af LAR servicen.Nej
categoryOverskrives altid med medication af LAR servicen.Nej
criticalityKritikalitet af allergien. Er enten low, high eller unnable-to-assess.Nej
substanceSubstans 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
substanceDescriptionTekstuel beskrivelse af substansen.Nej
patientPatient 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.Ja
onsetDateTimeTidspunkt allergien er identificeret.Ja
recorderLægefaglig person, der har indberettet allergien. Består af en code og system. System er oid koden for autorisationskoder og code er autorsationskoden.Ja
recorderDescriptionrecorderOrganizationOrganisation der har indberettet allergien. Består af en code og system. System er oid for SOR og code er SOR koden.Ja
noteNote omkring allergienNej
reactionReaktion på allergien. Består af:
  • manifestation: Code og system for reaktionen. System er oid for SKS.
  • manifestationDescription: Tekstuel beskrivelse.
  • onset: Tidspunkt hvor reaktionen er observeret.
  • severity: Hvor alvorlig reaktionen er. Enten Mildmild, moderate eller severe.
Ja


RegisterPatientAllergyResponse

Består af ReplyStatus og en liste af MedicationAllergyIntoleranceReduced.

ReplyStatus
ElementBeskrivelsePåkrævet
StatusCode

Status kode på forespørgselen.

Kan være en af følgende: Success, NotValidData, ProblemCallingCave

Ja
StatusTextStatus tekst svarende til status koden. Med uddybende beskrivelse af evt. fejl.Ja


GetPatientAllergyList

GetPatientAllergyListRequest

ElementBeskrivelsePåkrævet
patientPatient 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
requesterOrganizationOrganization der foretager forespørgslen. Består af en code og en type. Code er organization og type er shak, sor eller ydernummer.Ja
consentOverrideIndikation af om der skal foretages værdispring.Ja


GetPatientAllergyListResponse

Består af ReplyStatus og en liste af MedicationAllergyIntoleranceReduced.

ReplyStatus
ElementBeskrivelsePåkrævet
StatusCode

Status kode på forespørgselen.

Kan være en af følgende: Success, NotValidData, ProblemCallingCave, MsbTechnicalError, TreatmentRelationTechhnicalError, SamtykkeTechnicalError, MinLogTechnicalError, SuccessButDataSpecificConsent, NegativeConsent

Ja
StatusTextStatus tekst svarende til status koden. Med uddybende beskrivelse af evt. fejl.Ja
MedicationAllergyIntoleranceReduced

BeskrivelsePåkrævet
identifierId på registreringen.
Ja
Nej
clinicalStatusStatus på registreringen. Er enten Active, Inactive eller ResolvedJa
verificationStatusAltid confirmed.Nej
typeAltid allergy.Nej
categoryAltid medication.Nej
criticalityKritikalitet af allergien. Er enten low, high eller unnable-to-assess.Nej
substanceSubstans 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
substanceDescriptionTekstuel beskrivelse af substansen.Nej
patientPatient 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.Ja
onsetDateTimeTidspunkt allergien er identificeret.Ja
recorderLæ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
recorderOrganizationOrganisation der har indberettet allergien. Består af en code og system. System er oid for SOR og code er SOR koden.Ja
noteNote omkring allergienNej
reactionReaktion på allergien. Består af:
  • manifestation: Code og system for reaktionen. System er oid for SKS.
  • manifestationDescription: Tekstuel beskrivelse.
  • onset: Tidspunkt hvor reaktionen er observeret.
  • severity: Hvor alvorlig reaktionen er. Enten
Mild
  • mild, moderate eller severe.
Ja

Anvendte kodesystemer

De steder i snitfladen, hvor der er beskrevet, at der anvendes et kode system (f.eks. oid for ATC), så er det nedentående systemer, der tillades i LAR servicen. 

SystemKodeKort beskrivelse
ATCurn:oid:2.16.840.1.113883.6.73
Klssifikation
Klassifikation af lægemiddel efter indholdsstof og virkemåde.
SORurn:oid:1.2.208.176.1.1Sundhedsvæsenets organisationsregister
Autorisationskodeurn:oid:1.2.208.176.1.3Autorisationskoder for sundhedspersonale i Danmark.
CPRurn:oid:1.2.208.176.1.2Det centrale personregister
SKSurn:oid:1.2.208.176.2.4.12Sundhedsvæsenets Klassifikations System


Eksempler

Eksempler på request of response til de SOAP operationer der udstilles. De enekelte elementer er beskrevet under snitfladebeskrivelse. Klient proxier kan genereres ud fra WSDL filen.

RegisterPatientAllergy

Nedenstående er et eksempel på SOAP request, der anvendes til at registrere oplysninger. De enekelte elementer er beskrevet under snitfladebeskrivelse.

Code Block
languagexml
<?xml version="1.0"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Header>...</soap:Header>
  <soap:Body>
    <ns6:RegisterPatientAllergyRequest xmlns:ns2="urn:oasis:names:tc:SAML:2.0:assertion" xmlns:ns3="http://www.w3.org/2000/09/xmldsig#" xmlns:ns4="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" xmlns:ns5="http://www.medcom.dk/dgws/2006/04/dgws-1.0.xsd" xmlns:ns6="http://sdsnsp.dk/medicationallergyservice/2018/11/21/" xmlns:ns7="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd" xmlns:ns8="http://sdsnsp.dk/medicationallergyservice/allergy/2018/11/21/">
      <MedicationAllergyIntoleranceReduced>
        <ns8:identifier>494de20b-32ec-4955-8886-5514bd063c25</ns8:identifier>
        <ns8:clinicalStatus value="active"/>
        <ns8:verificationStatus value="confirmed"/>
        <ns8:type value="allergy"/>
        <ns8:category value="medication"/>
        <ns8:criticality value="high"/>
        <ns8:substance>
          <ns8:system>urn:oid:2.16.840.1.113883.6.73</ns8:system>
          <ns8:code>648005</ns8:code>
        </ns8:substance>
        <ns8:substanceDescription>648005 description</ns8:substanceDescription>
        <ns8:patient>
          <ns8:system>urn:oid:1.2.208.176.1.2</ns8:system>
          <ns8:code>1601010020</ns8:code>
        </ns8:patient>
        <ns8:onsetDateTime>2018-11-01T13:30:00.000+01:00</ns8:onsetDateTime>
        <ns8:recorder>
          <ns8:system>urn:oid:1.2.208.176.1.3</ns8:system>
          <ns8:code>1234</ns8:code>
        </ns8:recorder>
        <ns8:recorderOrganization>
          <ns8:system>urn:oid:1.2.208.176.1.1</ns8:system>
          <ns8:code>1234567890</ns8:code>
        </ns8:recorderOrganization>
        <ns8:note>Oil of calamus allergy</ns8:note>
        <ns8:reaction>
          <ns8:manifestation>
            <ns8:system>urn:oid:1.2.208.176.2.4.12</ns8:system>
            <ns8:code>5678</ns8:code>
          </ns8:manifestation>
          <ns8:manifestationDescription>Severe reaction was observed for several hours</ns8:manifestationDescription>
          <ns8:onset>2018-11-01T13:30:00.000+01:00</ns8:onset>
          <ns8:severity value="mild"/>
        </ns8:reaction>
      </MedicationAllergyIntoleranceReduced>
    </ns6:RegisterPatientAllergyRequest>
  </soap:Body>
</soap:Envelope>

...

Nedenstående er SOAP svar på ovestående ovenstående request.

Code Block
languagexml
<?xml version="1.0"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Header>...</soap:Header>
  <soap:Body>
    <ns6:RegisterPatientAllergyResponse xmlns:ns2="urn:oasis:names:tc:SAML:2.0:assertion" xmlns:ns3="http://www.w3.org/2000/09/xmldsig#" xmlns:ns4="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" xmlns:ns5="http://www.medcom.dk/dgws/2006/04/dgws-1.0.xsd" xmlns:ns6="http://sdsnsp.dk/medicationallergyservice/2018/11/21/" xmlns:ns7="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd" xmlns:ns8="http://sdsnsp.dk/medicationallergyservice/allergy/2018/11/21/">
      <ReplyStatus>
        <ns6:StatusCode>Success</ns6:StatusCode>
        <ns6:StatusText>Kald til servicen var successfuld</ns6:StatusText>
      </ReplyStatus>
    </ns6:RegisterPatientAllergyResponse>
  </soap:Body>
</soap:Envelope>

...

Nedenstående er eksempel på SOAP reqyet request, der anvende til at læse data. 

Code Block
languagexml
<?xml version="1.0"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Header>...</soap:Header>
  <soap:Body>
    <ns6:GetPatientAllergyListRequest xmlns:ns2="urn:oasis:names:tc:SAML:2.0:assertion" xmlns:ns3="http://www.w3.org/2000/09/xmldsig#" xmlns:ns4="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" xmlns:ns5="http://www.medcom.dk/dgws/2006/04/dgws-1.0.xsd" xmlns:ns6="http://sdsnsp.dk/medicationallergyservice/2018/11/21/" xmlns:ns7="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd" xmlns:ns8="http://sdsnsp.dk/medicationallergyservice/allergy/2018/11/21/">
      <MedicationAllergyIntoleranceSearchCriteria>
        <ns6:patient>
          <ns6:system>urn:oid:1.2.208.176.1.2</ns6:system>
          <ns6:code>1601010020</ns6:code>
        </ns6:patient>
        <ns6:requesterOrganization>
          <ns6:type value="sor"/>
          <ns6:code>12345</ns6:code>
        </ns6:requesterOrganization>
        <ns6:consentOverride>false</ns6:consentOverride>
      </MedicationAllergyIntoleranceSearchCriteria>
    </ns6:GetPatientAllergyListRequest>
  </soap:Body>
</soap:Envelope>


Nendenstående Nedenstående er SOAP svar på ovestående ovenstående request.

Code Block
languagexml
<?xml version="1.0"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Header>...</soap:Header>
  <soap:Body>
    <ns6:GetPatientAllergyListResponse xmlns:ns2="urn:oasis:names:tc:SAML:2.0:assertion" xmlns:ns3="http://www.w3.org/2000/09/xmldsig#" xmlns:ns4="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" xmlns:ns5="http://www.medcom.dk/dgws/2006/04/dgws-1.0.xsd" xmlns:ns6="http://sdsnsp.dk/medicationallergyservice/2018/11/21/" xmlns:ns7="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd" xmlns:ns8="http://sdsnsp.dk/medicationallergyservice/allergy/2018/11/21/">
      <ReplyStatus>
        <ns6:StatusCode>Success</ns6:StatusCode>
        <ns6:StatusText>Kald til servicen var successfuld</ns6:StatusText>
      </ReplyStatus>
      <MedicationAllergyIntoleranceReduced>
        <ns8:identifier>494de20b-32ec-4955-8886-5514bd063c25</ns8:identifier>
        <ns8:clinicalStatus value="active"/>
        <ns8:verificationStatus value="confirmed"/>
        <ns8:type value="allergy"/>
        <ns8:category value="medication"/>
        <ns8:criticality value="high"/>
        <ns8:substance>
          <ns8:system>urn:oid:2.16.840.1.113883.6.73</ns8:system>
          <ns8:code>648005</ns8:code>
        </ns8:substance>
        <ns8:substanceDescription>648005 description</ns8:substanceDescription>
        <ns8:patient>
          <ns8:system>urn:oid:1.2.208.176.1.2</ns8:system>
          <ns8:code>1601010020</ns8:code>
        </ns8:patient>
        <ns8:onsetDateTime>2018-11-01T13:30:00.000+01:00</ns8:onsetDateTime>
        <ns8:recorder>
          <ns8:system>urn:oid:1.2.208.176.1.3</ns8:system>
          <ns8:code>1234</ns8:code>
        </ns8:recorder>
        <ns8:recorderOrganization>
          <ns8:system>urn:oid:1.2.208.176.1.1</ns8:system>
          <ns8:code>1234567890</ns8:code>
        </ns8:recorderOrganization>
        <ns8:note>Oil of calamus allergy</ns8:note>
        <ns8:reaction>
          <ns8:manifestation>
            <ns8:system>urn:oid:1.2.208.176.2.4.12</ns8:system>
            <ns8:code>5678</ns8:code>
          </ns8:manifestation>
          <ns8:manifestationDescription>Severe reaction was observed for several hours</ns8:manifestationDescription>
          <ns8:onset>2018-11-01T13:30:00.000+01:00</ns8:onset>
          <ns8:severity value="mild"/>
        </ns8:reaction>
      </MedicationAllergyIntoleranceReduced>
    </ns6:GetPatientAllergyListResponse>
  </soap:Body>
</soap:Envelope>

...