Search

ZD Coverage

Resources conforming to this profile are requested by ZorgDomein when SSO to ZorgDomein has succeeded and patient details are fetched from the source system.

Queries on the https://[FHIRServerUrl]/Coverage endpoint may include the following query parameters:

  • subscriber=[PatientID]: [PatientID] will refer to the patient ID that was provided in the JWT during SSO.
  • _include=Coverage:payor: indicates that the search result must also contain the Organization resource that is referred to by Coverage.payor.

The canonical URL for this profile is:

http://zorgdomein.nl/fhir/StructureDefinition/zd-coverage

This profile builds on Coverage.


identifierS Σ0..*Identifier
statusΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
policyHolderΣ0..1Reference(Patient | RelatedPerson | Organization)
subscriberS Σ1..1Reference(Patient | RelatedPerson)
subscriberIdΣ0..1string
beneficiaryΣ0..1Reference(Patient)
relationship0..1CodeableConcept
periodΣ0..1Period
referenceΣ0..1string
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ1..1uriFixed Value
valueΣ1..1string
periodΣ0..1Period
assignerΣ0..1Reference(Organization)
displayΣ0..1string
groupΣ0..1string
groupDisplayΣ0..1string
subGroupΣ0..1string
subGroupDisplayΣ0..1string
planΣ0..1string
planDisplayΣ0..1string
subPlanΣ0..1string
subPlanDisplayΣ0..1string
classΣ0..1string
classDisplayΣ0..1string
subClassΣ0..1string
subClassDisplayΣ0..1string
dependentΣ0..1string
sequenceΣ0..1string
orderΣ0..1positiveInt
networkΣ0..1string
contract0..*Reference(Contract)

See the profile on simplifier.net for additional details.

Resource example

Below you find an example of a ZD Coverage resource. 

{
  "resourceType" : "Coverage",
  "id" : "zd-coverage-1",
  "meta" : {
    "profile" : [
      "http://zorgdomein.nl/fhir/StructureDefinition/zd-coverage"
    ]
  },
  "identifier" : [
    {
      "value" : "A123456780",
      "assigner" : {
        "identifier" : {
          "system" : "http://nictiz.nl/fhir/NamingSystem/uzovi",
          "value" : "0101"
        },
        "display" : "N.V. Univé Zorg"
      }
    }
  ],
  "status" : "active",
  "subscriber" : {
    "reference" : "Patient/zd-patient-1"
  },
  "beneficiary" : {
    "reference" : "Patient/zd-patient-1"
  },
  "relationship" : {
    "coding" : [
      {
        "code" : "self"
      }
    ]
  },
  "payor" : [
    {
      "identifier" : {
        "system" : "http://nictiz.nl/fhir/NamingSystem/uzovi",
        "value" : "0101"
      },
      "display" : "N.V. Univé Zorg"
    }
  ]
}
<?xml version="1.0" encoding="UTF-8"?>
<Coverage xmlns="http://hl7.org/fhir">
  <id value="zd-coverage-1"/>
  <meta>
    <profile value="http://zorgdomein.nl/fhir/StructureDefinition/zd-coverage"/>
  </meta>
  <identifier>
    <value value="A123456780"/>
    <assigner>
      <identifier>
        <system value="http://nictiz.nl/fhir/NamingSystem/uzovi"/>
        <value value="0101"/>
      </identifier>
      <display value="N.V. Univé Zorg"/>
    </assigner>
  </identifier>
  <status value="active"/>
  <subscriber>
    <reference value="Patient/zd-patient-1"/>
  </subscriber>
  <beneficiary>
    <reference value="Patient/zd-patient-1"/>
  </beneficiary>
  <relationship>
    <coding>
      <code value="self"/>
    </coding>
  </relationship>
  <payor>
    <identifier>
      <system value="http://nictiz.nl/fhir/NamingSystem/uzovi"/>
      <value value="0101"/>
    </identifier>
    <display value="N.V. Univé Zorg"/>
  </payor>
</Coverage>