Search

ZD Patient

Resources conforming to this profile are requested by ZorgDomein when SSO has succeeded and patient details are fetched from the source system. Patient resources are requested by FHIR read request (i.e. a direct call on the patient id like https://[FHIRServerUrl]/Patient/[PatientID]).

Resources conforming to the ZD Patient profile are sent by ZorgDomein as part of a Bundle that is sent to deliver a FHIR document to the information system of the referrer or care provider.

The canonical URL for this profile is:

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

This profile builds on Patient.


url 1..1 uriFixed Value
valueReference 1..1 Reference(nl-core-organization)
use Σ ?! 1..1 codeBindingFixed Value
type Σ 0..1 CodeableConceptBinding
system Σ 1..1 uriFixed Value
value Σ 1..1 string
period Σ 0..1 Period
assigner Σ 0..1 Reference(Organization)
active Σ ?! 0..1 boolean
name S Σ 0..* nl-core-humanname
system Σ 1..1 codeBinding
value Σ 1..1 string
use Σ ?! 0..1 codeBinding
rank Σ 0..1 positiveInt
period Σ 0..1 Period
gender S Σ 0..1 codeBinding
birthDate S Σ 0..1 date
deceasedBoolean boolean
deceasedDateTime dateTime
url 1..1 uriFixed Value
valueCodeableConcept 0..1 CodeableConceptBinding
url 1..1 uriFixed Value
valueBoolean 1..1 boolean
use Σ ?! 0..1 codeBinding
type Σ 0..1 codeBinding
text Σ 0..1 string
url 1..1 uriFixed Value
valueString 0..1 string
url 1..1 uriFixed Value
valueString 0..1 string
url 1..1 uriFixed Value
valueString 0..1 string
url 1..1 uriFixed Value
valueString 0..1 string
url 1..1 uriFixed Value
valueString 0..1 string
url 1..1 uriFixed Value
valueBase64Binary base64Binary
valueBoolean boolean
valueCode code
valueDate date
valueDateTime dateTime
valueDecimal decimal
valueId id
valueInstant instant
valueInteger integer
valueMarkdown markdown
valueOid oid
valuePositiveInt positiveInt
valueString string
valueTime time
valueUnsignedInt unsignedInt
valueUri uri
valueAddress Address
valueAge Age
valueAnnotation Annotation
valueAttachment Attachment
valueCodeableConcept CodeableConcept
valueCoding Coding
valueContactPoint ContactPoint
valueCount Count
valueDistance Distance
valueDuration Duration
valueHumanName HumanName
valueIdentifier Identifier
valueMoney Money
valuePeriod Period
valueQuantity Quantity
valueRange Range
valueRatio Ratio
valueSampledData SampledData
valueSignature Signature
valueTiming Timing
valueMeta Meta
valueReference Reference()
url 1..1 uriFixed Value
valueBase64Binary base64Binary
valueBoolean boolean
valueCode code
valueDate date
valueDateTime dateTime
valueDecimal decimal
valueId id
valueInstant instant
valueInteger integer
valueMarkdown markdown
valueOid oid
valuePositiveInt positiveInt
valueString string
valueTime time
valueUnsignedInt unsignedInt
valueUri uri
valueAddress Address
valueAge Age
valueAnnotation Annotation
valueAttachment Attachment
valueCodeableConcept CodeableConcept
valueCoding Coding
valueContactPoint ContactPoint
valueCount Count
valueDistance Distance
valueDuration Duration
valueHumanName HumanName
valueIdentifier Identifier
valueMoney Money
valuePeriod Period
valueQuantity Quantity
valueRange Range
valueRatio Ratio
valueSampledData SampledData
valueSignature Signature
valueTiming Timing
valueMeta Meta
valueReference Reference()
city Σ 0..1 string
district Σ 0..1 string
state Σ 0..1 string
postalCode Σ 0..1 string
url 1..1 uriFixed Value
countryGBACodelist Σ 0..* CodingBinding
countryISOCodelist Σ 0..* CodingBinding
text Σ 0..1 string
period Σ 0..1 Period
maritalStatus 0..1 CodeableConceptBinding
multipleBirthBoolean boolean
multipleBirthInteger integer
photo 0..* Attachment
relationship 0..* CodeableConceptBinding
name 0..1 HumanName
telecom 0..* ContactPoint
address 0..1 Address
gender 0..1 codeBinding
organization 0..1 Reference(Organization)
period 0..1 Period
language 1..1 CodeableConceptBinding
preferred 0..1 boolean
generalPractitioner 0..* Reference(Organization | Practitioner)
managingOrganization Σ 0..1 Reference(Organization)
other Σ 1..1 Reference(Patient | RelatedPerson)
type Σ 1..1 codeBinding

See the profile on simplifier.net for additional details.

Resource example

Below you find an example of a Patient resource that conforms to the ZD Patient profile.

    {
      "resourceType": "Patient",
      "id": "zd-patient-1",
      "meta": {
        "profile": [
          "http://zorgdomein.nl/fhir/StructureDefinition/zd-patient"
        ]
      },
      "identifier": [
        {
          "use": "official",
          "system": "http://fhir.nl/fhir/NamingSystem/bsn",
          "value": "695752947"
        }
      ],
      "name": [
        {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/humanname-assembly-order",
              "valueCode": "NL4"
            }
          ],
          "use": "official",
          "family": "Aelbrinck-de Jager",
          "_family": {
            "extension": [
              {
                "url": "http://hl7.org/fhir/StructureDefinition/humanname-own-name",
                "valueString": "Aelbrinck"
              },
              {
                "url": "http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix",
                "valueString": "de"
              },
              {
                "url": "http://hl7.org/fhir/StructureDefinition/humanname-partner-name",
                "valueString": "Jager"
              }
            ]
          },
          "given": [
            "Kristel",
            "K."
          ],
          "_given": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier",
                  "valueCode": "CL"
                }
              ]
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier",
                  "valueCode": "IN"
                }
              ]
            }
          ]
        }
      ],
      "telecom": [
        {
          "system": "phone",
          "value": "0650896532",
          "use": "mobile"
        },
        {
          "system": "email",
          "value": "k.aelbrinck@home.nl",
          "use": "home"
        }
      ],
      "gender": "female",
      "birthDate": "1979-02-02",
      "address": [
        {
          "extension": [
            {
              "url": "http://fhir.nl/fhir/StructureDefinition/nl-core-address-official",
              "valueBoolean": true
            }
          ],
          "type": "physical",
          "line": [
            "Zuiderhaven 1a 2hg"
          ],
          "_line": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName",
                  "valueString": "Zuiderhaven"
                },
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber",
                  "valueString": "1"
                },
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-buildingNumberSuffix",
                  "valueString": "a"
                },
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator",
                  "valueString": "2hg"
                }
              ]
            }
          ],
          "city": "Amsterdam",
          "postalCode": "1060HT",
          "country": "NL"
        }
      ]
    }
    
    <Patient xmlns='http://hl7.org/fhir'>
      <id value='zd-patient-1'/>
      <meta>
        <profile value='http://zorgdomein.nl/fhir/StructureDefinition/zd-patient'/>
      </meta>
      <identifier>
        <use value='official'/>
        <system value='http://fhir.nl/fhir/NamingSystem/bsn'/>
        <value value='695752947'/>
      </identifier>
      <name>
        <extension url='http://hl7.org/fhir/StructureDefinition/humanname-assembly-order'>
          <valueCode value='NL4'/>
        </extension>
        <use value='official'/>
        <family value='Aelbrinck-de Jager'>
          <extension url='http://hl7.org/fhir/StructureDefinition/humanname-own-name'>
            <valueString value='Aelbrinck'/>
          </extension>
          <extension url='http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix'>
            <valueString value='de'/>
          </extension>
          <extension url='http://hl7.org/fhir/StructureDefinition/humanname-partner-name'>
            <valueString value='Jager'/>
          </extension>
        </family>
        <given value='Kristel'>
          <extension url='http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier'>
            <valueCode value='CL'/>
          </extension>
        </given>
        <given value='K.'>
          <extension url='http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier'>
            <valueCode value='IN'/>
          </extension>
        </given>
      </name>
      <telecom>
        <system value='phone'/>
        <value value='0650896532'/>
        <use value='mobile'/>
      </telecom>
      <telecom>
        <system value='email'/>
        <value value='k.aelbrinck@home.nl'/>
        <use value='home'/>
      </telecom>
      <gender value='female'/>
      <birthDate value='1979-02-02'/>
      <address>
        <extension url='http://fhir.nl/fhir/StructureDefinition/nl-core-address-official'>
          <valueBoolean value='true'/>
        </extension>
        <type value='physical'/>
        <line value='Zuiderhaven 1a 2hg'>
          <extension url='http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName'>
            <valueString value='Zuiderhaven'/>
          </extension>
          <extension url='http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber'>
            <valueString value='1'/>
          </extension>
          <extension url='http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-buildingNumberSuffix'>
            <valueString value='a'/>
          </extension>
          <extension url='http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator'>
            <valueString value='2hg'/>
          </extension>
        </line>
        <city value='Amsterdam'/>
        <postalCode value='1060HT'/>
        <country value='NL'/>
      </address>
    </Patient>