RIVO Noord Zorgviewer MVP2 Implementation Guide
0.2.1 - CI build
RIVO Noord Zorgviewer MVP2 Implementation Guide - Local Development build (v0.2.1). See the Directory of published versions
Official URL: http://hl7.nl/fhir/zorgviewer/StructureDefinition/Practitioner | Version: 0.2.1 | |||
Draft as of 2023-03-22 | Computable Name: Practitioner |
The minimal Practitioner for the Zorgviewer
Dit Profiel is het resultaat van de vergelijking tussen de zib2017 FHIR Profiel en de implementaties in Epic en Chipsoft. De elementen die in ieder geval in alle output beschikbaar zullen zijn. Voornamelijk bedoeld voor houvast van een client en voor validatie van output.
De Zorgviewer-backend ZOU na bevragen van het bronsysteem aan elk resultaat resource een meta-tag MOETEN toevoegen met de VEKTIZ code van de zorgaanbieder, zodat dit kan worden gebruikt in de presentatie in de Zorgviewer-frontend.
Toevoegen aan elke response, dus per resource (bij een read) of per Bundle (bij een search):
{ ...
"meta": {
"tag": [
{ "system": "http://hl7.nl/fhir/zorgviewer-ig/bronsysteem-zorgaanbieder",
"code": "06020101",
"display": "UMCG"
} ] }
... }
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from nl-core-practitioner
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Practitioner | 0..* | nl-core-practitioner | HealthProfessional | |
identifier | C | 1..* | Identifier | HealthProfessionalIdentificationNumber zv-pra-3: Either Practitioner BIG or AGB-Z identifier SHALL be present. |
identifier:AGB | S | 0..1 | Identifier | AGB |
identifier:BIG | S | 0..1 | Identifier | BIG |
name | SC | 1..* | nl-core-humanname | NameInformation zv-pra-1: Either Practitioner.name.given and/or Practitioner.name.family and/or Practitioner.name.text SHALL be present. zv-pra-2: To be usable for a wide range of internationally available applications, the Patient.name.text SHOULD be present. |
Documentation for this format |
Id | Grade | Path(s) | Details | Requirements |
zv-pra-1 | error | Practitioner.name | Either Practitioner.name.given and/or Practitioner.name.family and/or Practitioner.name.text SHALL be present. : (family.exists() or given.exists() or text.exists()) | |
zv-pra-2 | best practice | Practitioner.name | To be usable for a wide range of internationally available applications, the Patient.name.text SHOULD be present. : text.exists() | |
zv-pra-3 | error | Practitioner.identifier | Either Practitioner BIG or AGB-Z identifier SHALL be present. : (identifier.exists()) |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Practitioner | 0..* | nl-core-practitioner | HealthProfessional | |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
Slices for identifier | ΣC | 1..* | Identifier | HealthProfessionalIdentificationNumber Slice: Unordered, Open by value:system zv-pra-3: Either Practitioner BIG or AGB-Z identifier SHALL be present. |
identifier:UZI | Σ | 0..1 | Identifier | UZI |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
system | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: http://fhir.nl/fhir/NamingSystem/uzi-nr-pers |
value | Σ | 1..1 | string | The value that is unique Example General: 123456 Example Example: 01011234 |
identifier:AGB | SΣ | 0..1 | Identifier | AGB |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
system | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: http://fhir.nl/fhir/NamingSystem/agb-z |
value | Σ | 1..1 | string | The value that is unique Example General: 123456 Example Example: 123456 |
identifier:BIG | SΣ | 0..1 | Identifier | BIG |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
system | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: http://fhir.nl/fhir/NamingSystem/big |
value | Σ | 1..1 | string | The value that is unique Example General: 123456 Example Example: 12345678 |
name | SC | 1..* | nl-core-humanname | NameInformation zv-pra-1: Either Practitioner.name.given and/or Practitioner.name.family and/or Practitioner.name.text SHALL be present. zv-pra-2: To be usable for a wide range of internationally available applications, the Patient.name.text SHOULD be present. Example Structured HumanName (preferred above unstructured): {"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/humanname-assembly-order","valueCode":"NL4"}],"text":"Irma Jongeneel-de Haas","family":"Jongeneel-de Haas","_family":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/humanname-own-name","valueString":"Jongeneel"},{"url":"http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix","valueString":"de"},{"url":"http://hl7.org/fhir/StructureDefinition/humanname-partner-name","valueString":"Haas"}]},"given":["Irma"]} Example Unstructured HumanName: {"text":"Irma Jongeneel-de Haas"} |
address | C | 0..* | nl-core-address | AddressInformation Example Example of a Vacation Home address: {"extension":[{"url":"http://nictiz.nl/fhir/StructureDefinition/zib-AddressInformation-AddressType","valueCodeableConcept":{"coding":[{"system":"http://hl7.org/fhir/v3/AddressUse","code":"HV","display":"Vakantie adres"}]}}],"use":"temp","line":["Binnenkant 12A Hoog"],"city":"Amsterdam","state":"NH","postalCode":"1000AA","country":"NLD"} Example Example of a Primary Home address: {"extension":[{"url":"http://nictiz.nl/fhir/StructureDefinition/zib-AddressInformation-AddressType","valueCodeableConcept":{"coding":[{"system":"http://hl7.org/fhir/v3/AddressUse","code":"HP","display":"Officieel adres"}]}},{"url":"http://fhir.nl/fhir/StructureDefinition/nl-core-address-official","valueBoolean":true}],"use":"home","line":["Binnenkant to 10"],"city":"Amsterdam","state":"NH","postalCode":"1001AA","country":"NLD"} |
Documentation for this format |
Path | Conformance | ValueSet |
Practitioner.identifier:UZI.use | required | IdentifierUse |
Practitioner.identifier:AGB.use | required | IdentifierUse |
Practitioner.identifier:BIG.use | required | IdentifierUse |
Id | Grade | Path(s) | Details | Requirements |
dom-1 | error | Practitioner | If the resource is contained in another resource, it SHALL NOT contain any narrative : contained.text.empty() | |
dom-2 | error | Practitioner | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Practitioner | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource : contained.where(('#'+id in %resource.descendants().reference).not()).empty() | |
dom-4 | error | Practitioner | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
nl-core-humanname-1 | error | Practitioner.name | if you specify a prefix for an own name then an own name is also expected : name.family.extension('http://hl7.org/fhir/StructureDefinition/humanname-own-prefix').empty().not() implies name.family.extension('http://hl7.org/fhir/StructureDefinition/humanname-own-name').empty().not() | |
nl-core-humanname-2 | error | Practitioner.name | if you specify a voorvoegsel for a partner name then a partner name is also expected : name.family.extension('http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix').empty().not() implies name.family.extension('http://hl7.org/fhir/StructureDefinition/humanname-partner-name').empty().not() | |
nl-streetname-if-official-and-other-line-parts | error | Practitioner.address | Address.streetName in an official address SHALL have a value if one of houseNumber|buildingNumberSuffix|additionalLocator has a value : (extension.where(url = 'http://fhir.nl/fhir/StructureDefinition/nl-core-address-official').where(value = true)).empty() or (line.extension.where(url = 'http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName').empty().not() and (line.extension.where(url='http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber').empty().not() or line.extension.where(url='http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-buildingNumberSuffix').empty().not() or line.extension.where(url='http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator').empty().not())) | This constraint checks conformance against the Dutch BRP constraints on address parts. However: when you only send postalCode + houseNumber which is enough for certain cases this may still be a valid address |
zv-pra-1 | error | Practitioner.name | Either Practitioner.name.given and/or Practitioner.name.family and/or Practitioner.name.text SHALL be present. : (family.exists() or given.exists() or text.exists()) | |
zv-pra-2 | best practice | Practitioner.name | To be usable for a wide range of internationally available applications, the Patient.name.text SHOULD be present. : text.exists() | |
zv-pra-3 | error | Practitioner.identifier | Either Practitioner BIG or AGB-Z identifier SHALL be present. : (identifier.exists()) |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Practitioner | 0..* | nl-core-practitioner | HealthProfessional | |||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: Common Languages (extensible): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
extension | 0..* | Extension | Additional Content defined by implementations | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
Slices for identifier | ΣC | 1..* | Identifier | HealthProfessionalIdentificationNumber Slice: Unordered, Open by value:system zv-pra-3: Either Practitioner BIG or AGB-Z identifier SHALL be present. | ||||
identifier:UZI | Σ | 0..1 | Identifier | UZI | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
system | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: http://fhir.nl/fhir/NamingSystem/uzi-nr-pers | ||||
value | Σ | 1..1 | string | The value that is unique Example General: 123456 Example Example: 01011234 | ||||
period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
identifier:AGB | SΣ | 0..1 | Identifier | AGB | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
system | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: http://fhir.nl/fhir/NamingSystem/agb-z | ||||
value | Σ | 1..1 | string | The value that is unique Example General: 123456 Example Example: 123456 | ||||
period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
identifier:BIG | SΣ | 0..1 | Identifier | BIG | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
system | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: http://fhir.nl/fhir/NamingSystem/big | ||||
value | Σ | 1..1 | string | The value that is unique Example General: 123456 Example Example: 12345678 | ||||
period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
active | Σ | 0..1 | boolean | Whether this practitioner's record is in active use | ||||
name | SC | 1..* | nl-core-humanname | NameInformation zv-pra-1: Either Practitioner.name.given and/or Practitioner.name.family and/or Practitioner.name.text SHALL be present. zv-pra-2: To be usable for a wide range of internationally available applications, the Patient.name.text SHOULD be present. Example Structured HumanName (preferred above unstructured): {"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/humanname-assembly-order","valueCode":"NL4"}],"text":"Irma Jongeneel-de Haas","family":"Jongeneel-de Haas","_family":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/humanname-own-name","valueString":"Jongeneel"},{"url":"http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix","valueString":"de"},{"url":"http://hl7.org/fhir/StructureDefinition/humanname-partner-name","valueString":"Haas"}]},"given":["Irma"]} Example Unstructured HumanName: {"text":"Irma Jongeneel-de Haas"} | ||||
telecom | C | 0..* | nl-core-contactpoint | ContactInformation Example Mobile business phone number. Note: the mobile nature stems from the number being an 06-* number.: {"system":"phone","value":"+31611234567","use":"work"} Example Mobile phone number undetermined private/business. Note: the mobile nature stems from the number being an 06-* number.: {"system":"phone","value":"+31611234567","use":"mobile"} Example Primary Home Land Line: {"extension":[{"url":"http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType","valueCodeableConcept":{"coding":[{"system":"urn:oid:2.16.840.1.113883.2.4.3.11.60.40.4.22.1","code":"LL","display":"Land Line"}]}}],"system":"phone","value":"...","use":"home"} Example Temporary Land Line: {"extension":[{"url":"http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType","valueCodeableConcept":{"coding":[{"system":"urn:oid:2.16.840.1.113883.2.4.3.11.60.40.4.22.1","code":"LL","display":"Land Line"}]}}],"system":"phone","value":"...","use":"temp"} Example Primary Work Land Line: {"extension":[{"url":"http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType","valueCodeableConcept":{"coding":[{"system":"urn:oid:2.16.840.1.113883.2.4.3.11.60.40.4.22.1","code":"LL","display":"Land Line"}]}}],"system":"phone","value":"...","use":"work"} Example Primary Home Fax: {"extension":[{"url":"http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType","valueCodeableConcept":{"coding":[{"system":"urn:oid:2.16.840.1.113883.2.4.3.11.60.40.4.22.1","code":"FAX","display":"Fax"}]}}],"system":"fax","value":"...","use":"home"} Example Temporary Fax: {"extension":[{"url":"http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType","valueCodeableConcept":{"coding":[{"system":"urn:oid:2.16.840.1.113883.2.4.3.11.60.40.4.22.1","code":"FAX","display":"Fax"}]}}],"system":"fax","value":"...","use":"temp"} Example Primary Work Fax: {"extension":[{"url":"http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType","valueCodeableConcept":{"coding":[{"system":"urn:oid:2.16.840.1.113883.2.4.3.11.60.40.4.22.1","code":"FAX","display":"Fax"}]}}],"system":"fax","value":"...","use":"work"} Example Primary Home Mobile Phone: {"extension":[{"url":"http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType","valueCodeableConcept":{"coding":[{"system":"http://hl7.org/fhir/v3/AddressUse","code":"MC","display":"Mobile Phone"}]}}],"system":"phone","value":"...","use":"home"} Example Temporary Mobile Phone: {"extension":[{"url":"http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType","valueCodeableConcept":{"coding":[{"system":"http://hl7.org/fhir/v3/AddressUse","code":"MC","display":"Mobile Phone"}]}}],"system":"phone","value":"...","use":"temp"} Example Primary Work Mobile Phone: {"extension":[{"url":"http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType","valueCodeableConcept":{"coding":[{"system":"http://hl7.org/fhir/v3/AddressUse","code":"MC","display":"Mobile Phone"}]}}],"system":"phone","value":"...","use":"work"} Example Primary Home Pager: {"extension":[{"url":"http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType","valueCodeableConcept":{"coding":[{"system":"http://hl7.org/fhir/v3/AddressUse","code":"PG","display":"Pager"}]}}],"system":"pager","value":"...","use":"home"} Example Temporary Pager: {"extension":[{"url":"http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType","valueCodeableConcept":{"coding":[{"system":"http://hl7.org/fhir/v3/AddressUse","code":"PG","display":"Pager"}]}}],"system":"pager","value":"...","use":"temp"} Example Primary Work Pager: {"extension":[{"url":"http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType","valueCodeableConcept":{"coding":[{"system":"http://hl7.org/fhir/v3/AddressUse","code":"PG","display":"Pager"}]}}],"system":"pager","value":"...","use":"work"} Example Private email address: {"system":"email","value":"giesput@myweb.nl","use":"home"} Example Work email address: {"system":"email","value":"example@workplace.nl","use":"work"} | ||||
address | C | 0..* | nl-core-address | AddressInformation Example Example of a Vacation Home address: {"extension":[{"url":"http://nictiz.nl/fhir/StructureDefinition/zib-AddressInformation-AddressType","valueCodeableConcept":{"coding":[{"system":"http://hl7.org/fhir/v3/AddressUse","code":"HV","display":"Vakantie adres"}]}}],"use":"temp","line":["Binnenkant 12A Hoog"],"city":"Amsterdam","state":"NH","postalCode":"1000AA","country":"NLD"} Example Example of a Primary Home address: {"extension":[{"url":"http://nictiz.nl/fhir/StructureDefinition/zib-AddressInformation-AddressType","valueCodeableConcept":{"coding":[{"system":"http://hl7.org/fhir/v3/AddressUse","code":"HP","display":"Officieel adres"}]}},{"url":"http://fhir.nl/fhir/StructureDefinition/nl-core-address-official","valueBoolean":true}],"use":"home","line":["Binnenkant to 10"],"city":"Amsterdam","state":"NH","postalCode":"1001AA","country":"NLD"} | ||||
gender | Σ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | ||||
birthDate | Σ | 0..1 | date | The date on which the practitioner was born | ||||
photo | 0..* | Attachment | Image of the person | |||||
qualification | 0..* | BackboneElement | Qualifications obtained by training and certification | |||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
extension | 0..* | Extension | Additional Content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | 0..* | Identifier | An identifier for this qualification for the practitioner | |||||
code | 1..1 | CodeableConcept | Coded representation of the qualification Binding: v2 table 0360, Version 2.7 (example): Specific qualification the practitioner has to provide a service | |||||
period | 0..1 | Period | Period during which the qualification is valid | |||||
issuer | 0..1 | Reference(Organization) | Organization that regulates and issues the qualification | |||||
communication | 0..* | CodeableConcept | A language the practitioner is able to use in patient communication Binding: Common Languages (extensible): A human language.
| |||||
Documentation for this format |
Path | Conformance | ValueSet | ||||
Practitioner.language | extensible | Common Languages
| ||||
Practitioner.identifier:UZI.use | required | IdentifierUse | ||||
Practitioner.identifier:UZI.type | extensible | Identifier Type Codes | ||||
Practitioner.identifier:AGB.use | required | IdentifierUse | ||||
Practitioner.identifier:AGB.type | extensible | Identifier Type Codes | ||||
Practitioner.identifier:BIG.use | required | IdentifierUse | ||||
Practitioner.identifier:BIG.type | extensible | Identifier Type Codes | ||||
Practitioner.gender | required | AdministrativeGender | ||||
Practitioner.qualification.code | example | v2 table 0360, Version 2.7 | ||||
Practitioner.communication | extensible | Common Languages
|
Id | Grade | Path(s) | Details | Requirements |
cpt-2 | error | Practitioner.telecom | A system is required if a value is provided. : value.empty() or system.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
nl-core-humanname-1 | error | Practitioner.name | if you specify a prefix for an own name then an own name is also expected : name.family.extension('http://hl7.org/fhir/StructureDefinition/humanname-own-prefix').empty().not() implies name.family.extension('http://hl7.org/fhir/StructureDefinition/humanname-own-name').empty().not() | |
nl-core-humanname-2 | error | Practitioner.name | if you specify a voorvoegsel for a partner name then a partner name is also expected : name.family.extension('http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix').empty().not() implies name.family.extension('http://hl7.org/fhir/StructureDefinition/humanname-partner-name').empty().not() | |
nl-streetname-if-official-and-other-line-parts | error | Practitioner.address | Address.streetName in an official address SHALL have a value if one of houseNumber|buildingNumberSuffix|additionalLocator has a value : (extension.where(url = 'http://fhir.nl/fhir/StructureDefinition/nl-core-address-official').where(value = true)).empty() or (line.extension.where(url = 'http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName').empty().not() and (line.extension.where(url='http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber').empty().not() or line.extension.where(url='http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-buildingNumberSuffix').empty().not() or line.extension.where(url='http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator').empty().not())) | This constraint checks conformance against the Dutch BRP constraints on address parts. However: when you only send postalCode + houseNumber which is enough for certain cases this may still be a valid address |
zv-pra-1 | error | Practitioner.name | Either Practitioner.name.given and/or Practitioner.name.family and/or Practitioner.name.text SHALL be present. : (family.exists() or given.exists() or text.exists()) | |
zv-pra-2 | best practice | Practitioner.name | To be usable for a wide range of internationally available applications, the Patient.name.text SHOULD be present. : text.exists() | |
zv-pra-3 | error | Practitioner.identifier | Either Practitioner BIG or AGB-Z identifier SHALL be present. : (identifier.exists()) |
This structure is derived from nl-core-practitioner
Differential View
This structure is derived from nl-core-practitioner
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Practitioner | 0..* | nl-core-practitioner | HealthProfessional | |
identifier | C | 1..* | Identifier | HealthProfessionalIdentificationNumber zv-pra-3: Either Practitioner BIG or AGB-Z identifier SHALL be present. |
identifier:AGB | S | 0..1 | Identifier | AGB |
identifier:BIG | S | 0..1 | Identifier | BIG |
name | SC | 1..* | nl-core-humanname | NameInformation zv-pra-1: Either Practitioner.name.given and/or Practitioner.name.family and/or Practitioner.name.text SHALL be present. zv-pra-2: To be usable for a wide range of internationally available applications, the Patient.name.text SHOULD be present. |
Documentation for this format |
Id | Grade | Path(s) | Details | Requirements |
zv-pra-1 | error | Practitioner.name | Either Practitioner.name.given and/or Practitioner.name.family and/or Practitioner.name.text SHALL be present. : (family.exists() or given.exists() or text.exists()) | |
zv-pra-2 | best practice | Practitioner.name | To be usable for a wide range of internationally available applications, the Patient.name.text SHOULD be present. : text.exists() | |
zv-pra-3 | error | Practitioner.identifier | Either Practitioner BIG or AGB-Z identifier SHALL be present. : (identifier.exists()) |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Practitioner | 0..* | nl-core-practitioner | HealthProfessional | |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
Slices for identifier | ΣC | 1..* | Identifier | HealthProfessionalIdentificationNumber Slice: Unordered, Open by value:system zv-pra-3: Either Practitioner BIG or AGB-Z identifier SHALL be present. |
identifier:UZI | Σ | 0..1 | Identifier | UZI |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
system | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: http://fhir.nl/fhir/NamingSystem/uzi-nr-pers |
value | Σ | 1..1 | string | The value that is unique Example General: 123456 Example Example: 01011234 |
identifier:AGB | SΣ | 0..1 | Identifier | AGB |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
system | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: http://fhir.nl/fhir/NamingSystem/agb-z |
value | Σ | 1..1 | string | The value that is unique Example General: 123456 Example Example: 123456 |
identifier:BIG | SΣ | 0..1 | Identifier | BIG |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
system | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: http://fhir.nl/fhir/NamingSystem/big |
value | Σ | 1..1 | string | The value that is unique Example General: 123456 Example Example: 12345678 |
name | SC | 1..* | nl-core-humanname | NameInformation zv-pra-1: Either Practitioner.name.given and/or Practitioner.name.family and/or Practitioner.name.text SHALL be present. zv-pra-2: To be usable for a wide range of internationally available applications, the Patient.name.text SHOULD be present. Example Structured HumanName (preferred above unstructured): {"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/humanname-assembly-order","valueCode":"NL4"}],"text":"Irma Jongeneel-de Haas","family":"Jongeneel-de Haas","_family":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/humanname-own-name","valueString":"Jongeneel"},{"url":"http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix","valueString":"de"},{"url":"http://hl7.org/fhir/StructureDefinition/humanname-partner-name","valueString":"Haas"}]},"given":["Irma"]} Example Unstructured HumanName: {"text":"Irma Jongeneel-de Haas"} |
address | C | 0..* | nl-core-address | AddressInformation Example Example of a Vacation Home address: {"extension":[{"url":"http://nictiz.nl/fhir/StructureDefinition/zib-AddressInformation-AddressType","valueCodeableConcept":{"coding":[{"system":"http://hl7.org/fhir/v3/AddressUse","code":"HV","display":"Vakantie adres"}]}}],"use":"temp","line":["Binnenkant 12A Hoog"],"city":"Amsterdam","state":"NH","postalCode":"1000AA","country":"NLD"} Example Example of a Primary Home address: {"extension":[{"url":"http://nictiz.nl/fhir/StructureDefinition/zib-AddressInformation-AddressType","valueCodeableConcept":{"coding":[{"system":"http://hl7.org/fhir/v3/AddressUse","code":"HP","display":"Officieel adres"}]}},{"url":"http://fhir.nl/fhir/StructureDefinition/nl-core-address-official","valueBoolean":true}],"use":"home","line":["Binnenkant to 10"],"city":"Amsterdam","state":"NH","postalCode":"1001AA","country":"NLD"} |
Documentation for this format |
Path | Conformance | ValueSet |
Practitioner.identifier:UZI.use | required | IdentifierUse |
Practitioner.identifier:AGB.use | required | IdentifierUse |
Practitioner.identifier:BIG.use | required | IdentifierUse |
Id | Grade | Path(s) | Details | Requirements |
dom-1 | error | Practitioner | If the resource is contained in another resource, it SHALL NOT contain any narrative : contained.text.empty() | |
dom-2 | error | Practitioner | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Practitioner | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource : contained.where(('#'+id in %resource.descendants().reference).not()).empty() | |
dom-4 | error | Practitioner | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
nl-core-humanname-1 | error | Practitioner.name | if you specify a prefix for an own name then an own name is also expected : name.family.extension('http://hl7.org/fhir/StructureDefinition/humanname-own-prefix').empty().not() implies name.family.extension('http://hl7.org/fhir/StructureDefinition/humanname-own-name').empty().not() | |
nl-core-humanname-2 | error | Practitioner.name | if you specify a voorvoegsel for a partner name then a partner name is also expected : name.family.extension('http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix').empty().not() implies name.family.extension('http://hl7.org/fhir/StructureDefinition/humanname-partner-name').empty().not() | |
nl-streetname-if-official-and-other-line-parts | error | Practitioner.address | Address.streetName in an official address SHALL have a value if one of houseNumber|buildingNumberSuffix|additionalLocator has a value : (extension.where(url = 'http://fhir.nl/fhir/StructureDefinition/nl-core-address-official').where(value = true)).empty() or (line.extension.where(url = 'http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName').empty().not() and (line.extension.where(url='http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber').empty().not() or line.extension.where(url='http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-buildingNumberSuffix').empty().not() or line.extension.where(url='http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator').empty().not())) | This constraint checks conformance against the Dutch BRP constraints on address parts. However: when you only send postalCode + houseNumber which is enough for certain cases this may still be a valid address |
zv-pra-1 | error | Practitioner.name | Either Practitioner.name.given and/or Practitioner.name.family and/or Practitioner.name.text SHALL be present. : (family.exists() or given.exists() or text.exists()) | |
zv-pra-2 | best practice | Practitioner.name | To be usable for a wide range of internationally available applications, the Patient.name.text SHOULD be present. : text.exists() | |
zv-pra-3 | error | Practitioner.identifier | Either Practitioner BIG or AGB-Z identifier SHALL be present. : (identifier.exists()) |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Practitioner | 0..* | nl-core-practitioner | HealthProfessional | |||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: Common Languages (extensible): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
extension | 0..* | Extension | Additional Content defined by implementations | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
Slices for identifier | ΣC | 1..* | Identifier | HealthProfessionalIdentificationNumber Slice: Unordered, Open by value:system zv-pra-3: Either Practitioner BIG or AGB-Z identifier SHALL be present. | ||||
identifier:UZI | Σ | 0..1 | Identifier | UZI | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
system | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: http://fhir.nl/fhir/NamingSystem/uzi-nr-pers | ||||
value | Σ | 1..1 | string | The value that is unique Example General: 123456 Example Example: 01011234 | ||||
period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
identifier:AGB | SΣ | 0..1 | Identifier | AGB | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
system | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: http://fhir.nl/fhir/NamingSystem/agb-z | ||||
value | Σ | 1..1 | string | The value that is unique Example General: 123456 Example Example: 123456 | ||||
period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
identifier:BIG | SΣ | 0..1 | Identifier | BIG | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
system | Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: http://fhir.nl/fhir/NamingSystem/big | ||||
value | Σ | 1..1 | string | The value that is unique Example General: 123456 Example Example: 12345678 | ||||
period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
active | Σ | 0..1 | boolean | Whether this practitioner's record is in active use | ||||
name | SC | 1..* | nl-core-humanname | NameInformation zv-pra-1: Either Practitioner.name.given and/or Practitioner.name.family and/or Practitioner.name.text SHALL be present. zv-pra-2: To be usable for a wide range of internationally available applications, the Patient.name.text SHOULD be present. Example Structured HumanName (preferred above unstructured): {"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/humanname-assembly-order","valueCode":"NL4"}],"text":"Irma Jongeneel-de Haas","family":"Jongeneel-de Haas","_family":{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/humanname-own-name","valueString":"Jongeneel"},{"url":"http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix","valueString":"de"},{"url":"http://hl7.org/fhir/StructureDefinition/humanname-partner-name","valueString":"Haas"}]},"given":["Irma"]} Example Unstructured HumanName: {"text":"Irma Jongeneel-de Haas"} | ||||
telecom | C | 0..* | nl-core-contactpoint | ContactInformation Example Mobile business phone number. Note: the mobile nature stems from the number being an 06-* number.: {"system":"phone","value":"+31611234567","use":"work"} Example Mobile phone number undetermined private/business. Note: the mobile nature stems from the number being an 06-* number.: {"system":"phone","value":"+31611234567","use":"mobile"} Example Primary Home Land Line: {"extension":[{"url":"http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType","valueCodeableConcept":{"coding":[{"system":"urn:oid:2.16.840.1.113883.2.4.3.11.60.40.4.22.1","code":"LL","display":"Land Line"}]}}],"system":"phone","value":"...","use":"home"} Example Temporary Land Line: {"extension":[{"url":"http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType","valueCodeableConcept":{"coding":[{"system":"urn:oid:2.16.840.1.113883.2.4.3.11.60.40.4.22.1","code":"LL","display":"Land Line"}]}}],"system":"phone","value":"...","use":"temp"} Example Primary Work Land Line: {"extension":[{"url":"http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType","valueCodeableConcept":{"coding":[{"system":"urn:oid:2.16.840.1.113883.2.4.3.11.60.40.4.22.1","code":"LL","display":"Land Line"}]}}],"system":"phone","value":"...","use":"work"} Example Primary Home Fax: {"extension":[{"url":"http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType","valueCodeableConcept":{"coding":[{"system":"urn:oid:2.16.840.1.113883.2.4.3.11.60.40.4.22.1","code":"FAX","display":"Fax"}]}}],"system":"fax","value":"...","use":"home"} Example Temporary Fax: {"extension":[{"url":"http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType","valueCodeableConcept":{"coding":[{"system":"urn:oid:2.16.840.1.113883.2.4.3.11.60.40.4.22.1","code":"FAX","display":"Fax"}]}}],"system":"fax","value":"...","use":"temp"} Example Primary Work Fax: {"extension":[{"url":"http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType","valueCodeableConcept":{"coding":[{"system":"urn:oid:2.16.840.1.113883.2.4.3.11.60.40.4.22.1","code":"FAX","display":"Fax"}]}}],"system":"fax","value":"...","use":"work"} Example Primary Home Mobile Phone: {"extension":[{"url":"http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType","valueCodeableConcept":{"coding":[{"system":"http://hl7.org/fhir/v3/AddressUse","code":"MC","display":"Mobile Phone"}]}}],"system":"phone","value":"...","use":"home"} Example Temporary Mobile Phone: {"extension":[{"url":"http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType","valueCodeableConcept":{"coding":[{"system":"http://hl7.org/fhir/v3/AddressUse","code":"MC","display":"Mobile Phone"}]}}],"system":"phone","value":"...","use":"temp"} Example Primary Work Mobile Phone: {"extension":[{"url":"http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType","valueCodeableConcept":{"coding":[{"system":"http://hl7.org/fhir/v3/AddressUse","code":"MC","display":"Mobile Phone"}]}}],"system":"phone","value":"...","use":"work"} Example Primary Home Pager: {"extension":[{"url":"http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType","valueCodeableConcept":{"coding":[{"system":"http://hl7.org/fhir/v3/AddressUse","code":"PG","display":"Pager"}]}}],"system":"pager","value":"...","use":"home"} Example Temporary Pager: {"extension":[{"url":"http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType","valueCodeableConcept":{"coding":[{"system":"http://hl7.org/fhir/v3/AddressUse","code":"PG","display":"Pager"}]}}],"system":"pager","value":"...","use":"temp"} Example Primary Work Pager: {"extension":[{"url":"http://nictiz.nl/fhir/StructureDefinition/zib-ContactInformation-TelecomType","valueCodeableConcept":{"coding":[{"system":"http://hl7.org/fhir/v3/AddressUse","code":"PG","display":"Pager"}]}}],"system":"pager","value":"...","use":"work"} Example Private email address: {"system":"email","value":"giesput@myweb.nl","use":"home"} Example Work email address: {"system":"email","value":"example@workplace.nl","use":"work"} | ||||
address | C | 0..* | nl-core-address | AddressInformation Example Example of a Vacation Home address: {"extension":[{"url":"http://nictiz.nl/fhir/StructureDefinition/zib-AddressInformation-AddressType","valueCodeableConcept":{"coding":[{"system":"http://hl7.org/fhir/v3/AddressUse","code":"HV","display":"Vakantie adres"}]}}],"use":"temp","line":["Binnenkant 12A Hoog"],"city":"Amsterdam","state":"NH","postalCode":"1000AA","country":"NLD"} Example Example of a Primary Home address: {"extension":[{"url":"http://nictiz.nl/fhir/StructureDefinition/zib-AddressInformation-AddressType","valueCodeableConcept":{"coding":[{"system":"http://hl7.org/fhir/v3/AddressUse","code":"HP","display":"Officieel adres"}]}},{"url":"http://fhir.nl/fhir/StructureDefinition/nl-core-address-official","valueBoolean":true}],"use":"home","line":["Binnenkant to 10"],"city":"Amsterdam","state":"NH","postalCode":"1001AA","country":"NLD"} | ||||
gender | Σ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | ||||
birthDate | Σ | 0..1 | date | The date on which the practitioner was born | ||||
photo | 0..* | Attachment | Image of the person | |||||
qualification | 0..* | BackboneElement | Qualifications obtained by training and certification | |||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
extension | 0..* | Extension | Additional Content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | 0..* | Identifier | An identifier for this qualification for the practitioner | |||||
code | 1..1 | CodeableConcept | Coded representation of the qualification Binding: v2 table 0360, Version 2.7 (example): Specific qualification the practitioner has to provide a service | |||||
period | 0..1 | Period | Period during which the qualification is valid | |||||
issuer | 0..1 | Reference(Organization) | Organization that regulates and issues the qualification | |||||
communication | 0..* | CodeableConcept | A language the practitioner is able to use in patient communication Binding: Common Languages (extensible): A human language.
| |||||
Documentation for this format |
Path | Conformance | ValueSet | ||||
Practitioner.language | extensible | Common Languages
| ||||
Practitioner.identifier:UZI.use | required | IdentifierUse | ||||
Practitioner.identifier:UZI.type | extensible | Identifier Type Codes | ||||
Practitioner.identifier:AGB.use | required | IdentifierUse | ||||
Practitioner.identifier:AGB.type | extensible | Identifier Type Codes | ||||
Practitioner.identifier:BIG.use | required | IdentifierUse | ||||
Practitioner.identifier:BIG.type | extensible | Identifier Type Codes | ||||
Practitioner.gender | required | AdministrativeGender | ||||
Practitioner.qualification.code | example | v2 table 0360, Version 2.7 | ||||
Practitioner.communication | extensible | Common Languages
|
Id | Grade | Path(s) | Details | Requirements |
cpt-2 | error | Practitioner.telecom | A system is required if a value is provided. : value.empty() or system.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
nl-core-humanname-1 | error | Practitioner.name | if you specify a prefix for an own name then an own name is also expected : name.family.extension('http://hl7.org/fhir/StructureDefinition/humanname-own-prefix').empty().not() implies name.family.extension('http://hl7.org/fhir/StructureDefinition/humanname-own-name').empty().not() | |
nl-core-humanname-2 | error | Practitioner.name | if you specify a voorvoegsel for a partner name then a partner name is also expected : name.family.extension('http://hl7.org/fhir/StructureDefinition/humanname-partner-prefix').empty().not() implies name.family.extension('http://hl7.org/fhir/StructureDefinition/humanname-partner-name').empty().not() | |
nl-streetname-if-official-and-other-line-parts | error | Practitioner.address | Address.streetName in an official address SHALL have a value if one of houseNumber|buildingNumberSuffix|additionalLocator has a value : (extension.where(url = 'http://fhir.nl/fhir/StructureDefinition/nl-core-address-official').where(value = true)).empty() or (line.extension.where(url = 'http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetName').empty().not() and (line.extension.where(url='http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber').empty().not() or line.extension.where(url='http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-buildingNumberSuffix').empty().not() or line.extension.where(url='http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator').empty().not())) | This constraint checks conformance against the Dutch BRP constraints on address parts. However: when you only send postalCode + houseNumber which is enough for certain cases this may still be a valid address |
zv-pra-1 | error | Practitioner.name | Either Practitioner.name.given and/or Practitioner.name.family and/or Practitioner.name.text SHALL be present. : (family.exists() or given.exists() or text.exists()) | |
zv-pra-2 | best practice | Practitioner.name | To be usable for a wide range of internationally available applications, the Patient.name.text SHOULD be present. : text.exists() | |
zv-pra-3 | error | Practitioner.identifier | Either Practitioner BIG or AGB-Z identifier SHALL be present. : (identifier.exists()) |
This structure is derived from nl-core-practitioner
Other representations of profile: CSV, Excel, Schematron