ZD PractitionerRole

Resources conforming to this 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-practitionerrole

This profile builds on PractitionerRole.

PractitionerRole	S I		PractitionerRole	There are no (further) constraints on this element Element Id PractitionerRole Short description Roles/organizations the practitioner is associated with Definition A specific set of Roles/Locations/specialties/services that a practitioner may perform at an organization for a period of time. Data Type PractitionerRole Constraints dom-2:If the resource is contained in another resource, it SHALL NOT contain nested Resources `contained.contained.empty()` dom-1:If the resource is contained in another resource, it SHALL NOT contain any narrative `contained.text.empty()` dom-4: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()` dom-3: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()` Mappings rim:Entity. Role, or Act v2:PRD (as one example) rim:Role servd:ServiceSiteProvider w5:administrative.individual
identifier	Σ	0..*	Identifier	There are no (further) constraints on this element Element Id PractitionerRole.identifier Short description Business Identifiers that are specific to a role/location Definition Business Identifiers that are specific to a role/location. Requirements Often, specific identities are assigned for the agent. Data Type Identifier Constraints ele-1:All FHIR elements must have a @value or children `hasValue() \| (children().count() > id.count())` Mappings rim:n/a v2:CX / EI (occasionally, more often EI maps to a resource id or a URL) rim:II - see see identifier pattern at http://wiki.hl7.org/index.php?title=Common_Design_Patterns#Identifier_Pattern for relevant discussion. The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT] servd:Identifier v2:PRD-7 (or XCN.1) rim:.id servd:./Identifiers w5:id
active	Σ	0..1	boolean	There are no (further) constraints on this element Element Id PractitionerRole.active Short description Whether this practitioner's record is in active use Definition Whether this practitioner's record is in active use. Requirements Need to be able to mark a practitioner record as not to be used because it was created in error. Comments Default is true. If the practitioner is not in use by one organization, then it should mark the period on the PractitonerRole with an end date (even if they are active) as they may be active in another role. Data Type boolean Constraints ele-1:All FHIR elements must have a @value or children `hasValue() \| (children().count() > id.count())` Default value true Mappings rim:n/a v2:STF-7 rim:.statusCode w5:status
period	Σ I	0..1	Period	There are no (further) constraints on this element Element Id PractitionerRole.period Short description The period during which the practitioner is authorized to perform in these role(s) Definition The period during which the person is authorized to act as a practitioner in these role(s) for the organization. Requirements Even after the agencies is revoked, the fact that it existed must still be recorded. Comments This is not a duration - that's a measure of time (a separate type), but a duration that occurs at a fixed value of time. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). If duration is required, specify the type as Interval\|Duration. Data Type Period Constraints ele-1:All FHIR elements must have a @value or children `hasValue() \| (children().count() > id.count())` per-1:If present, start SHALL have a lower value than end `start.empty() or end.empty() or (start <= end)` Mappings rim:n/a v2:DR rim:IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"] v2:PRD-8/9 / PRA-5.4 rim:.performance[@typeCode <= 'PPRF'].ActDefinitionOrEvent.effectiveTime servd:(ServD maps Practitioners and Organizations via another entity, so this concept is not available) w5:when.done
practitioner	S Σ I	0..1	Reference(ZD Practitioner)	Element Id PractitionerRole.practitioner Short description Practitioner that is able to provide the defined services for the organization Definition Practitioner that is able to provide the defined services for the organization. Comments References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Data Type Reference(ZD Practitioner) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() \| (children().count() > id.count())` ref-1:SHALL have a contained resource if a local reference is provided `reference.startsWith('#').not() or (reference.substring(1).trace('url') in %resource.contained.id.trace('ids'))` Mappings rim:n/a rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity) rim:.player
organization	S Σ I	1..1	Reference(ZD Organization)	Element Id PractitionerRole.organization Short description Organization where the roles are available Definition The organization where the Practitioner performs the roles associated. Comments References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Data Type Reference(ZD Organization) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() \| (children().count() > id.count())` ref-1:SHALL have a contained resource if a local reference is provided `reference.startsWith('#').not() or (reference.substring(1).trace('url') in %resource.contained.id.trace('ids'))` Mappings rim:n/a rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity) rim:.scoper
code	Σ	0..*	CodeableConcept	There are no (further) constraints on this element Element Id PractitionerRole.code Short description Roles which this practitioner may perform Definition Roles which this practitioner is authorized to perform for the organization. Requirements Need to know what authority the practitioner has - what can they do? Comments A person may have more than one role. At least one role is required. Data Type CodeableConcept Binding The role a person plays representing an organization PractitionerRole (example) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() \| (children().count() > id.count())` Mappings rim:n/a v2:CE/CNE/CWE rim:CD orim:fhir:CodeableConcept rdfs:subClassOf dt:CD v2:PRD-1 / STF-18 / PRA-3 / PRT-4 / ROL-3 / ORC-12 / OBR-16 / PV1-7 / PV1-8 / PV1-9 / PV1-17 rim:.code servd:(ServD maps Practitioners and Organizations via another entity, so this concept is not available)
specialty	Σ	0..*	CodeableConceptBinding	Element Id PractitionerRole.specialty Short description Specialty of the practitioner Definition Specific specialty of the practitioner. Comments Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. Data Type CodeableConcept Binding Specific specialty associated with the agency Practice Setting Code Value Set (preferred) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() \| (children().count() > id.count())` Mappings rim:n/a v2:CE/CNE/CWE rim:CD orim:fhir:CodeableConcept rdfs:subClassOf dt:CD v2:PRA-5 rim:.player.HealthCareProvider[@classCode = 'PROV'].code servd:./Specialty
coding	Σ	0..*	Coding	There are no (further) constraints on this element Element Id PractitionerRole.specialty.coding Short description Code defined by a terminology system Definition A reference to a code defined by a terminology system. Requirements Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. Comments Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. Data Type Coding Constraints ele-1:All FHIR elements must have a @value or children `hasValue() \| (children().count() > id.count())` Mappings rim:n/a v2:CE/CNE/CWE subset one of the sets of component 1-3 or 4-6 rim:CV orim:fhir:Coding rdfs:subClassOf dt:CDCoding v2:CE.1-8, CE.10-22 rim:union(., ./translation) orim:fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding
text	Σ	0..1	string	Element Id PractitionerRole.specialty.text Short description Plain text representation of the specialty Definition A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. Requirements The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. Comments Very often the text is the same as a displayName of one of the codings. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() \| (children().count() > id.count())` Mappings rim:n/a v2:CE.9. But note many systems use CE.2 for this rim:./originalText[mediaType/code="text/plain"]/data orim:fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText
location	S Σ I	0..*	Reference(ZD Location)	Element Id PractitionerRole.location Short description The location(s) at which this practitioner provides care Definition The location(s) at which this practitioner provides care. Comments References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Data Type Reference(ZD Location) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() \| (children().count() > id.count())` ref-1:SHALL have a contained resource if a local reference is provided `reference.startsWith('#').not() or (reference.substring(1).trace('url') in %resource.contained.id.trace('ids'))` Mappings rim:n/a rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity) rim:.performance.ActDefinitionOrEvent.ServiceDeliveryLocation[@classCode = 'SDLOC'] servd:(ServD maps Practitioners and Organizations via another entity, so this concept is not available)<br/> However these are accessed via the Site.ServiceSite.ServiceSiteProvider record. (The Site has the location) w5:where
healthcareService	I	0..*	Reference(HealthcareService)	Element Id PractitionerRole.healthcareService Short description ZorgDomein cluster Definition The list of healthcare services that this worker provides for this role's Organization/Location(s). Comments References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Data Type Reference(HealthcareService) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() \| (children().count() > id.count())` ref-1:SHALL have a contained resource if a local reference is provided `reference.startsWith('#').not() or (reference.substring(1).trace('url') in %resource.contained.id.trace('ids'))` Mappings rim:n/a rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity) v2:EDU-2 / AFF-3 rim:.player.QualifiedEntity[@classCode = 'QUAL'].code
reference	Σ I	0..1	string	There are no (further) constraints on this element Element Id PractitionerRole.healthcareService.reference Short description Literal reference, Relative, internal or absolute URL Definition A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. Comments Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() \| (children().count() > id.count())` Mappings rim:n/a rim:N/A
identifier	Σ	0..1	Identifier	There are no (further) constraints on this element Element Id PractitionerRole.healthcareService.identifier Short description Logical reference, when literal reference is not known Definition An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. Comments When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Data Type Identifier Constraints ele-1:All FHIR elements must have a @value or children `hasValue() \| (children().count() > id.count())` Mappings rim:n/a v2:CX / EI (occasionally, more often EI maps to a resource id or a URL) rim:II - see see identifier pattern at http://wiki.hl7.org/index.php?title=Common_Design_Patterns#Identifier_Pattern for relevant discussion. The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT] servd:Identifier rim:.identifier
display	Σ	0..1	string	Element Id PractitionerRole.healthcareService.display Short description ZorgDomein cluster name Definition Plain text narrative that identifies the resource in addition to the resource reference. Comments This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() \| (children().count() > id.count())` Mappings rim:n/a rim:N/A
telecom	Σ I	0..*	ContactPoint	There are no (further) constraints on this element Element Id PractitionerRole.telecom Short description Contact details that are specific to the role/location/service Definition Contact details that are specific to the role/location/service. Requirements Often practitioners have a dedicated line for each location (or service) that they work at, and need to be able to define separate contact details for each of these. Data Type ContactPoint Constraints ele-1:All FHIR elements must have a @value or children `hasValue() \| (children().count() > id.count())` cpt-2:A system is required if a value is provided. `value.empty() or system.exists()` Mappings rim:n/a v2:XTN rim:TEL servd:ContactPoint rim:.telecom
availableTime		0..*	BackboneElement	There are no (further) constraints on this element Element Id PractitionerRole.availableTime Short description Times the Service Site is available Definition A collection of times that the Service Site is available. Comments More detailed availability information may be provided in associated Schedule/Slot resources. Data Type BackboneElement Constraints ele-1:All FHIR elements must have a @value or children `hasValue() \| (children().count() > id.count())` Mappings rim:n/a rim:.effectiveTime
daysOfWeek		0..*	codeBinding	There are no (further) constraints on this element Element Id PractitionerRole.availableTime.daysOfWeek Short description mon \| tue \| wed \| thu \| fri \| sat \| sun Definition Indicates which days of the week are available between the start and end Times. Comments Note that FHIR strings may not exceed 1MB in size Data Type code Binding The days of the week. DaysOfWeek (required) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() \| (children().count() > id.count())` Mappings rim:n/a rim:.effectiveTime
allDay		0..1	boolean	There are no (further) constraints on this element Element Id PractitionerRole.availableTime.allDay Short description Always available? e.g. 24 hour service Definition Is this always available? (hence times are irrelevant) e.g. 24 hour service. Data Type boolean Constraints ele-1:All FHIR elements must have a @value or children `hasValue() \| (children().count() > id.count())` Mappings rim:n/a rim:.effectiveTime
availableStartTime		0..1	time	There are no (further) constraints on this element Element Id PractitionerRole.availableTime.availableStartTime Short description Opening time of day (ignored if allDay = true) Definition The opening time of day. Note: If the AllDay flag is set, then this time is ignored. Comments The timezone is expected to be for where this HealthcareService is provided at. Data Type time Constraints ele-1:All FHIR elements must have a @value or children `hasValue() \| (children().count() > id.count())` Mappings rim:n/a rim:.effectiveTime
availableEndTime		0..1	time	There are no (further) constraints on this element Element Id PractitionerRole.availableTime.availableEndTime Short description Closing time of day (ignored if allDay = true) Definition The closing time of day. Note: If the AllDay flag is set, then this time is ignored. Comments The timezone is expected to be for where this HealthcareService is provided at. Data Type time Constraints ele-1:All FHIR elements must have a @value or children `hasValue() \| (children().count() > id.count())` Mappings rim:n/a rim:.effectiveTime
notAvailable		0..*	BackboneElement	There are no (further) constraints on this element Element Id PractitionerRole.notAvailable Short description Not available during this time due to provided reason Definition The HealthcareService is not available during this period of time due to the provided reason. Data Type BackboneElement Constraints ele-1:All FHIR elements must have a @value or children `hasValue() \| (children().count() > id.count())` Mappings rim:n/a rim:.effectiveTime
description		1..1	string	There are no (further) constraints on this element Element Id PractitionerRole.notAvailable.description Short description Reason presented to the user explaining why time not available Definition The reason that can be presented to the user as to why this time is not available. Comments Note that FHIR strings may not exceed 1MB in size Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() \| (children().count() > id.count())` Mappings rim:n/a
during	I	0..1	Period	There are no (further) constraints on this element Element Id PractitionerRole.notAvailable.during Short description Service not availablefrom this date Definition Service is not available (seasonally or for a public holiday) from this date. Comments This is not a duration - that's a measure of time (a separate type), but a duration that occurs at a fixed value of time. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). If duration is required, specify the type as Interval\|Duration. Data Type Period Constraints ele-1:All FHIR elements must have a @value or children `hasValue() \| (children().count() > id.count())` per-1:If present, start SHALL have a lower value than end `start.empty() or end.empty() or (start <= end)` Mappings rim:n/a v2:DR rim:IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"] rim:.effectiveTime
availabilityExceptions		0..1	string	There are no (further) constraints on this element Element Id PractitionerRole.availabilityExceptions Short description Description of availability exceptions Definition A description of site availability exceptions, e.g. public holiday availability. Succinctly describing all possible exceptions to normal site availability as details in the available Times and not available Times. Comments Note that FHIR strings may not exceed 1MB in size Data Type string Constraints ele-1:All FHIR elements must have a @value or children `hasValue() \| (children().count() > id.count())` Mappings rim:n/a rim:.effectiveTime
endpoint	I	0..*	Reference(Endpoint)	There are no (further) constraints on this element Element Id PractitionerRole.endpoint Short description Technical endpoints providing access to services operated for the practitioner with this role Definition Technical endpoints providing access to services operated for the practitioner with this role. Requirements Organizations have multiple systems that provide various services and ,ay also be different for practitioners too. So the endpoint satisfies the need to be able to define the technical connection details for how to connect to them, and for what purpose. Comments References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Data Type Reference(Endpoint) Constraints ele-1:All FHIR elements must have a @value or children `hasValue() \| (children().count() > id.count())` ref-1:SHALL have a contained resource if a local reference is provided `reference.startsWith('#').not() or (reference.substring(1).trace('url') in %resource.contained.id.trace('ids'))` Mappings rim:n/a rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)

See the profile on simplifier.net for additional details.

Resource example

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

{
  "resourceType": "PractitionerRole",
  "id": "zd-practitionerrole-1",
  "meta": {
    "profile": [
      "http://zorgdomein.nl/fhir/StructureDefinition/zd-practitionerrole"
    ]
  },
  "practitioner": {
    "reference": "Practitioner/zd-practitioner-1",
    "display": "H. de Vries"
  },
  "organization": {
    "reference": "Organization/zd-organization-1",
    "display": "Huisartsenpraktijk ZorgDomein"
  },
  "location": [
    {
      "reference": "Location/zd-location-1",
      "display": "Locatie Breukelen"
    }
  ]
}

<PractitionerRole xmlns='http://hl7.org/fhir'>
  <id value='zd-practitionerrole-1'/>
  <meta>
    <profile value='http://zorgdomein.nl/fhir/StructureDefinition/zd-practitionerrole'/>
  </meta>
  <practitioner>
    <reference value='Practitioner/zd-practitioner-1'/>
    <display value='H. de Vries'/>
  </practitioner>
  <organization>
    <reference value='Organization/zd-organization-1'/>
    <display value='Huisartsenpraktijk ZorgDomein'/>
  </organization>
  <location>
    <reference value='Location/zd-location-1'/>
    <display value='Locatie Breukelen'/>
  </location>
</PractitionerRole>

ZD PractitionerRole

Resource example

Questions or comments?

Thank you!