Home Monitoring API

API specificaties

Home Monitoring API

API specificaties

De Home Monitoring API wordt gebruikt om digitale zorg applicaties die de toestand van een patiënt monitoren of anderszins vastleggen aan te sluiten op het EPD van een zorgaanbieder. Digitale zorg applicaties sturen een alert naar deze API van Zorgplatform. Zorgplatform levert de alert af bij de zorginstelling.

Deze API is beschikbaar voor alle aangesloten vertrouwde applicaties.

API specificaties

Policies
Versie
Request format
Response format
Operaties
Voorbeeld

API specificaties

Policies
Versie
Request format
Response format
Operaties
Voorbeeld

De Home Monitoring API kan alerts en updates op alerts uit thuismonitoringsystemen ontvangen en verwerken. Een verzonden alert / Flag leidt tot een item op de werklijst van de patiënt in het EPD, zichtbaar voor de door de zorginstelling bepaalde ontvangers. Een update van een alert leidt tot de afhandeling van de alert op de werklijst van de patiënt in het EPD.

Een alert wordt in het kader van een workflow gestuurd. Het is mogelijk om meerdere alerts per workflow te versturen. Alerts bij Zorgplatform moeten per stuk worden afgemeld. Dit hoeft niet sequentieel.

Policies
  • Operaties kunnen uitsluitend worden aangeroepen door een geldig Zorgplatform token mee te geven.
  • Alerts kunnen alleen worden gepost of geüpdatet indien dat gebeurt in het kader van een bestaande workflow / Task.
Versie

STU 3

Request format

HTTP POST application/fhir+json
HTTP PUT application/fhir+json

De partnerapplicatie stuurt alerts naar de Zorgplatform FHIR server door een POST request met de Flag resource naar het endpoint voor alerts. Een create actie is altijd zonder ID van de resource. Zorgplatform kent een ID toe aan de alert.

De partnerapplicatie updatet alerts bij de Zorgplatform FHIR server door middel van een PUT met de geüpdatete resource op het endpoint voor alerts. Een update-actie dient altijd met het ID van de resource uitgevoerd te worden. Bij een Flag resource kan bijvoorbeeld de status worden gewijzigd van ‘Active’ naar ‘Inactive’ wanneer de alert is afgehandeld.

Response format

application/fhir+json

Bij een POST ontvangt de partnerapplicatie een HTTP statuscode, een locatie en de gecreëerde resource, inclusief het toegekende ID. Het ID van de resource is later nodig indien de resource wordt geüpdatet. Zorgplatform handelt de binnengekomen resource af. In het geval van alerts wordt een actie van een zorgverlener verwacht en zal Zorgplatform de resource naar het desbetreffende zorginstelling sturen. In het informatiesysteem van de zorginstelling kan de afhandeling van een binnengekomen alert verschillend ingericht zijn, afhankelijk van de use case.

Bij de PUT maakt Zorgplatform gebruik van pessimistic locking. De partnerapplicatie ontvangt een HTTP statuscode. Zorgplatform handelt de verwerking van de resource daarna verder af.

Operaties

Flag resource

Voorbeeld

POST https://api.zorgplatform.online/fhir/v1/Flag
Authorization: Saml YWxhZGRpbjpvcGVuc2VzYW1l......
Content-Type: application/fhir+json

  "resourceType":"Flag",
  "meta":{
    "profile":[
      "http://nictiz.nl/fhir/StructureDefinition/zib-Alert"
    ]
  },
  "language":"nl-NL",
  "extension":[
    {
      "url":"http://hl7.org/fhir/StructureDefinition/flag-priority",
      "valueCodeableConcept":{
        "coding":[
          {
            "system":"http://hl7.org/fhir/flag-priority-code",
            "code":"PH"
          }
        ]
      }
    }
  ],
  "status":"active",
  "category":{
    "coding":[
      {
        "system":"http://loinc.org",
        "code":"74018-3",
        "display":"alert"
      }
    ]
  },
  "code":{
    "coding":[
      {
        "system":"http://snomed.info/sct",
        "code":"392570002",
        "display":"Blood pressure finding (finding)"
      }
    ]
  },
  "subject":{
    "identifier":{
      "system":"http://fhir.nl/fhir/NamingSystem/bsn",
      "value":"[BSN]"
    }
  },
  "period":{
    "start":"[datetime]"
  },
  "author":{
    "identifier":{
      "system":"http://hl7.org/fhir/StructureDefinition/oid",
      "value":"[OID]"
    },
    "display":"Test"
  }
}