NICE FHIR Implementation Guide

NICE-PractitionerRole

Description

This profile is for sumbitting data to the NICE about the specialism of the doctor referring the patient to the ICU.

Click here to go to the NICE-PractitionerRole Simplifier page

NICE data dictionary links

MDS
Referring Specialism

Source

This profile is used to submit referring specialism related information to the Dutch National Intensive Care Evaluation (NICE). It was derived from the Nictiz Health and Care Information Model (HCIM; Dutch: Zorginformatiebouwsteen or ZIB) PractitionerRole, 2017 release version 3.1

PractitionerRole

Element id

PractitionerRole

Short description

HealthProfessionalRole

Alternate names

ZorgverlenerRol

Definition

A specific set of Roles/Locations/specialties/services that a practitioner may perform at an organization for a period of time.

This profile should be used to submit the AGB specialty codes of the PractitionerRole. Other attributes of a PractitionerRole are not processed by NICE and do not need to be sent.

More information can be found in the NICE datadictionary: https://www.stichting-nice.nl/dd/#356

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

0..1

There are no (further) constraints on this element

Element id

PractitionerRole.id

Short description

Logical id of this artifact

Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

Comments

The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())

Mappings

rim: n/a

Meta

There are no (further) constraints on this element

Element id

PractitionerRole.meta

Short description

Metadata about the resource

Definition

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource.

Data type

Meta

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())

Mappings

rim: n/a
rim: N/A

implicitRules

Σ ?!

0..1

uri

There are no (further) constraints on this element

Element id

PractitionerRole.implicitRules

Short description

A set of rules under which this content was created

Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.

Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element.

This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.

Data type

uri

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())

Mappings

rim: n/a

language

0..1

codeBinding

There are no (further) constraints on this element

Element id

PractitionerRole.language

Short description

Language of the resource content

Definition

The base language in which the resource is written.

Comments

Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

Data type

code

Binding

A human language.

Common Languages (extensible)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())

Mappings

rim: n/a

text

0..1

Narrative

There are no (further) constraints on this element

Element id

PractitionerRole.text

Short description

Text summary of the resource, for human interpretation

Alternate names

narrative, html, xhtml, display

Definition

A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

Comments

Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded in formation is added later.

Data type

Narrative

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())

Mappings

rim: n/a
rim: N/A
rim: Act.text?

contained

0..*

Resource

There are no (further) constraints on this element

Element id

PractitionerRole.contained

Short description

Contained, inline Resources

Alternate names

inline resources, anonymous resources, contained resources

Definition

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

Comments

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.

Data type

Resource

Mappings

rim: Entity. Role, or Act
rim: N/A

extension

1..*

Extension

There are no (further) constraints on this element

Element id

PractitionerRole.extension

Short description

Additional Content defined by implementations

Alternate names

extensions, user content

Definition

May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Data type

Extension

Sliced:

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

Verified

S I

1..1

Extension(CodeableConcept)

Element id

PractitionerRole.extension:Verified

Short description

Is the instance validated by a medical professional?

Alternate names

extensions, user content

Definition

Extension that is used to indicate whether the entire instance has been validated.

Every instance shall be validated by a hospital member / datamanager. However, this is not always feasible in case of automated submission of NICE data elements. This extensions shall be used to indicate the validation status of the instance.

Comments

Data type

Extension(CodeableConcept)

Extension URL

https://fhir.stichting-nice.nl/STU3/StructureDefinition/NICE-Verified-2022Q1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

modifierExtension

?! I

0..*

Extension

There are no (further) constraints on this element

Element id

PractitionerRole.modifierExtension

Short description

Extensions that cannot be ignored

Alternate names

extensions, user content

Definition

May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Comments

Data type

Extension

Sliced:

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

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
hcim-basicelements-v1.0-2017EN: NL-CM:0.0.6

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

Σ I

0..1

Reference(nl-core-practitioner)

There are no (further) constraints on this element

Element id

PractitionerRole.practitioner

Short description

Practitioner that is able to provide the defined services for the organation

Definition

Practitioner that is able to provide the defined services for the organation.

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(nl-core-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

Σ I

0..1

Reference(nl-core-organization)

There are no (further) constraints on this element

Element id

PractitionerRole.organization

Short description

HealthcareProvider

Alternate names

Zorgaanbieder

Definition

The organization where the Practitioner performs the roles associated.

Comments

Data type

Reference(nl-core-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
hcim-healthprofessional-v1.2.1-2015EN: NL-CM:17.1.6
hcim-healthprofessional-v3.0-2016EN: NL-CM:17.1.6
hcim-healthprofessional-v3.2-2017EN: NL-CM:17.1.6

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. Note: in earlier versions of this profile there used to be an association with the HCIM element NL-CM:17.1.5 HealthcareProviderRole. This mapping was semantically incorrect. The HCIM element is a property of the association of PractitionerRole to some healthcare act. In a number of FHIR Resources the association is implicit from the semantics of the resource element like in Observation.performer. In others you can make this explicit like Encounter.participant.type, CareTeam.participant.role and Procedure.performer.role. Please refer to the relevant profiles on those resources for associations with HCIM NL-CM:17.1.5 HealthcareProviderRole

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..1

CodeableConceptBinding

Element id

PractitionerRole.specialty

Short description

Specialty

Alternate names

Specialisme

Definition

Healthcare provider’s medical specialty. This refers to the recognized medical specialties as stated in the BIG Act. A PractitionerRole instance SHALL be a singular assocation between a person acting in a certain specialty for a certain organization. It's possible however that either specialty or organization or both is/are uknown. It is also possible that equivalent specialisms are available in multiple coding systems e.g. 01.015 UZI (Huisarts) and 0101 AGB (Huisartsen, niet apotheekhoudend). For this reason you may use multiple coding elements, each indicating the relevant code from a different system.

For NICE the SpecialtyAGB coding is required in order to submit the 'Referring Specialism' data element.

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
hcim-healthprofessional-v1.2.1-2015EN: NL-CM:17.1.4
hcim-healthprofessional-v3.0-2016EN: NL-CM:17.1.4
hcim-healthprofessional-v3.2-2017EN: NL-CM:17.1.4
NICE-Datadictionary-MDS: https://www.stichting-nice.nl/dd/#356

0..1

string

There are no (further) constraints on this element

Element id

PractitionerRole.specialty.id

Short description

xml:id (or equivalent in JSON)

Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

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

extension

0..*

Extension

There are no (further) constraints on this element

Element id

PractitionerRole.specialty.extension

Short description

Additional Content defined by implementations

Alternate names

extensions, user content

Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Comments

Data type

Extension

Sliced:

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

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

Sliced:

Unordered, Open, by system(Value)

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: C*E.1-8, C*E.10-22
rim: union(., ./translation)
orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding

SpecialtyUZI

0..*

CodingBinding

There are no (further) constraints on this element

Element id

PractitionerRole.specialty.coding:SpecialtyUZI

Short description

SpecialtyUZI

Alternate names

SpecialismeUZI

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

Data type

Coding

Binding

SpecialismeUZICodelijst (required)

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: C*E.1-8, C*E.10-22
rim: union(., ./translation)
orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding

0..1

string

There are no (further) constraints on this element

Element id

PractitionerRole.specialty.coding:SpecialtyUZI.id

Short description

xml:id (or equivalent in JSON)

Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

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

extension

0..*

Extension

There are no (further) constraints on this element

Element id

PractitionerRole.specialty.coding:SpecialtyUZI.extension

Short description

Additional Content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Sliced:

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

system

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

PractitionerRole.specialty.coding:SpecialtyUZI.system

Short description

Identity of the terminology system

Definition

The identification of the code system that defines the meaning of the symbol in the code.

Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously.

Data type

uri

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())

Fixed value

http://fhir.nl/fhir/NamingSystem/uzi-rolcode

Mappings

rim: n/a
v2: C*E.3
rim: ./codeSystem
orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem

version

0..1

string

There are no (further) constraints on this element

Element id

PractitionerRole.specialty.coding:SpecialtyUZI.version

Short description

Version of the system - if relevant

Definition

The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

Comments

Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

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: C*E.7
rim: ./codeSystemVersion
orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion

code

0..1

code

There are no (further) constraints on this element

Element id

PractitionerRole.specialty.coding:SpecialtyUZI.code

Short description

Symbol in syntax defined by the system

Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Requirements

Need to refer to a particular code in the system.

Comments

Note that FHIR strings may not exceed 1MB in size

Data type

code

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())

Mappings

rim: n/a
v2: C*E.1
rim: ./code
orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code

display

0..1

string

There are no (further) constraints on this element

Element id

PractitionerRole.specialty.coding:SpecialtyUZI.display

Short description

Representation defined by the system

Definition

A representation of the meaning of the code in the system, following the rules of the system.

Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

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
v2: C*E.2 - but note this is not well followed
rim: CV.displayName
orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName

userSelected

0..1

boolean

There are no (further) constraints on this element

Element id

PractitionerRole.specialty.coding:SpecialtyUZI.userSelected

Short description

If this coding was chosen directly by the user

Definition

Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays).

Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

Data type

boolean

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())

Mappings

rim: n/a
v2: Sometimes implied by being first
rim: CD.codingRationale
orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]

SpecialtyAGB

S Σ

0..*

CodingBinding

Element id

PractitionerRole.specialty.coding:SpecialtyAGB

Short description

SpecialtyAGB

Alternate names

SpecialismeAGB

Definition

The AGB-code (Algemeen GegevensBeheer, or general datamanagement in English) is an unique code that identifies Dutch healthcareproviders. There are three types of AGB-codes:

Specialty-related;
Person-related;
And institution-related.

To identify the referring specialism (NICE data element) only specialty-related codes are required. For example, 0320 (Cardiology)

Requirements

Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.

Comments

Data type

Coding

Binding

SpecialismeAGBCodelijst (required)

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: C*E.1-8, C*E.10-22
rim: union(., ./translation)
orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding

0..1

string

There are no (further) constraints on this element

Element id

PractitionerRole.specialty.coding:SpecialtyAGB.id

Short description

xml:id (or equivalent in JSON)

Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

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

extension

0..*

Extension

There are no (further) constraints on this element

Element id

PractitionerRole.specialty.coding:SpecialtyAGB.extension

Short description

Additional Content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Sliced:

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

system

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

PractitionerRole.specialty.coding:SpecialtyAGB.system

Short description

Identity of the terminology system

Definition

The identification of the code system that defines the meaning of the symbol in the code.

Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

Data type

uri

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())

Fixed value

urn:oid:2.16.840.1.113883.2.4.6.7

Mappings

rim: n/a
v2: C*E.3
rim: ./codeSystem
orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem

version

0..1

string

There are no (further) constraints on this element

Element id

PractitionerRole.specialty.coding:SpecialtyAGB.version

Short description

Version of the system - if relevant

Definition

Comments

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: C*E.7
rim: ./codeSystemVersion
orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion

code

0..1

code

There are no (further) constraints on this element

Element id

PractitionerRole.specialty.coding:SpecialtyAGB.code

Short description

Symbol in syntax defined by the system

Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Requirements

Need to refer to a particular code in the system.

Comments

Note that FHIR strings may not exceed 1MB in size

Data type

code

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())

Mappings

rim: n/a
v2: C*E.1
rim: ./code
orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code

display

0..1

string

There are no (further) constraints on this element

Element id

PractitionerRole.specialty.coding:SpecialtyAGB.display

Short description

Representation defined by the system

Definition

A representation of the meaning of the code in the system, following the rules of the system.

Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

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
v2: C*E.2 - but note this is not well followed
rim: CV.displayName
orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName

userSelected

0..1

boolean

There are no (further) constraints on this element

Element id

PractitionerRole.specialty.coding:SpecialtyAGB.userSelected

Short description

If this coding was chosen directly by the user

Definition

Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays).

Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Data type

boolean

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())

Mappings

rim: n/a
v2: Sometimes implied by being first
rim: CD.codingRationale
orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]

text

0..1

string

There are no (further) constraints on this element

Element id

PractitionerRole.specialty.text

Short description

Plain text representation of the concept

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: C*E.9. But note many systems use C*E.2 for this
rim: ./originalText[mediaType/code="text/plain"]/data
orim: fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText

location

Σ I

0..*

Reference(Location)

There are no (further) constraints on this element

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

Data type

Reference(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

0..*

Reference(HealthcareService)

There are no (further) constraints on this element

Element id

PractitionerRole.healthcareService

Short description

The list of healthcare services that this worker provides for this role's Organization/Location(s)

Definition

The list of healthcare services that this worker provides for this role's Organization/Location(s).

Comments

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

telecom

Σ I

0..*

nl-core-contactpoint

There are no (further) constraints on this element

Element id

PractitionerRole.telecom

Short description

ContactInformation

Alternate names

Contactgegevens

Definition

Contact information includes a person's telephone numbers and email addresses. This datatype defines a common basis for expressing all contact information around the world, but adds extensions to express Dutch contacts specifically, according to the HCIM ContactInformation (v1.0, 2017). A Dutch ContactPoint still is a proper FHIR ContactPoint, which means that systems that cannot interpret the extensions will still be able to render and work with this datatype. The table below explains how the HCIM concepts are mapped to the various FHIR elements. The HCIM code itself should also be included using the TelecomType extension.

HCIM	`.ext:TelecomType`	`.system`	`.use`
Primary Home Land Line	LL	phone	home
Temporary Land Line	LL	phone	temp
Primary Work Land Line	LL	phone	work

Primary Home Fax	FAX	fax	home
Temporary Fax	FAX	fax	temp
Primary Work Fax	FAX	fax	work

Primary Home Mobile Phone	MC	phone	home
Temporary Mobile Phone	MC	phone	temp
Primary Work Mobile Phone	MC	phone	work

Primary Home Pager	PG	pager	home
Temporary Pager	PG	pager	temp
Primary Work Pager	PG	pager	work

Private email address		email	home
Work email address		email	work

Mobile phone number undetermined private/business		phone	mobile

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

nl-core-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()

Examples

Mobile business phone number. Note: the mobile nature stems from the number being an 06-* number.

{
  "system": "phone",
  "value": "+31611234567",
  "use": "work"
}

Mobile phone number undetermined private/business. Note: the mobile nature stems from the number being an 06-* number.

{
  "system": "phone",
  "value": "+31611234567",
  "use": "mobile"
}

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"
}

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"
}

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"
}

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"
}

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"
}

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"
}

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"
}

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"
}

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"
}

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"
}

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"
}

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"
}

Private email address

{
  "system": "email",
  "value": "giesput@myweb.nl",
  "use": "home"
}

Work email address

{
  "system": "email",
  "value": "example@workplace.nl",
  "use": "work"
}

Mappings

rim: n/a
v2: XTN
rim: TEL
servd: ContactPoint
rim: .telecom
hcim-contactinformation-v2.0.1-2015EN: NL-CM:0.1.5
hcim-contactinformation-v3.0-2016EN: NL-CM:0.1.5
hcim-contactinformation-v1.0-2017EN: NL-CM:20.6.1
hcim-healthprofessional-v1.2.1-2015EN: NL-CM:17.1.8
hcim-healthprofessional-v3.0-2016EN: NL-CM:17.1.8
hcim-healthprofessional-v3.2-2017EN: NL-CM:17.1.8

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

0..1

string

There are no (further) constraints on this element

Element id

PractitionerRole.availableTime.id

Short description

xml:id (or equivalent in JSON)

Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

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

extension

0..*

Extension

There are no (further) constraints on this element

Element id

PractitionerRole.availableTime.extension

Short description

Additional Content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Sliced:

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

modifierExtension

Σ ?! I

0..*

Extension

There are no (further) constraints on this element

Element id

PractitionerRole.availableTime.modifierExtension

Short description

Extensions that cannot be ignored

Alternate names

extensions, user content, modifiers

Definition

May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Comments

Data type

Extension

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

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

0..1

string

There are no (further) constraints on this element

Element id

PractitionerRole.notAvailable.id

Short description

xml:id (or equivalent in JSON)

Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

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

extension

0..*

Extension

There are no (further) constraints on this element

Element id

PractitionerRole.notAvailable.extension

Short description

Additional Content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Sliced:

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

modifierExtension

Σ ?! I

0..*

Extension

There are no (further) constraints on this element

Element id

PractitionerRole.notAvailable.modifierExtension

Short description

Extensions that cannot be ignored

Alternate names

extensions, user content, modifiers

Definition

Comments

Data type

Extension

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

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

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

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

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

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)

PractitionerRole

Element id

PractitionerRole

Short description

HealthProfessionalRole

Alternate names

ZorgverlenerRol

Definition

A specific set of Roles/Locations/specialties/services that a practitioner may perform at an organization for a period of time.

This profile should be used to submit the AGB specialty codes of the PractitionerRole. Other attributes of a PractitionerRole are not processed by NICE and do not need to be sent.

More information can be found in the NICE datadictionary: https://www.stichting-nice.nl/dd/#356

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

0..1

There are no (further) constraints on this element

Element id

PractitionerRole.id

Short description

Logical id of this artifact

Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

Comments

The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())

Mappings

rim: n/a

Meta

There are no (further) constraints on this element

Element id

PractitionerRole.meta

Short description

Metadata about the resource

Definition

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource.

Data type

Meta

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())

Mappings

rim: n/a
rim: N/A

implicitRules

Σ ?!

0..1

uri

There are no (further) constraints on this element

Element id

PractitionerRole.implicitRules

Short description

A set of rules under which this content was created

Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.

Comments

This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.

Data type

uri

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())

Mappings

rim: n/a

language

0..1

codeBinding

There are no (further) constraints on this element

Element id

PractitionerRole.language

Short description

Language of the resource content

Definition

The base language in which the resource is written.

Comments

Data type

code

Binding

A human language.

Common Languages (extensible)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())

Mappings

rim: n/a

text

0..1

Narrative

There are no (further) constraints on this element

Element id

PractitionerRole.text

Short description

Text summary of the resource, for human interpretation

Alternate names

narrative, html, xhtml, display

Definition

Comments

Data type

Narrative

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())

Mappings

rim: n/a
rim: N/A
rim: Act.text?

contained

0..*

Resource

There are no (further) constraints on this element

Element id

PractitionerRole.contained

Short description

Contained, inline Resources

Alternate names

inline resources, anonymous resources, contained resources

Definition

Comments

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.

Data type

Resource

Mappings

rim: Entity. Role, or Act
rim: N/A

extension

1..*

Extension

There are no (further) constraints on this element

Element id

PractitionerRole.extension

Short description

Additional Content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Sliced:

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

Verified

S I

1..1

Extension(CodeableConcept)

Element id

PractitionerRole.extension:Verified

Short description

Is the instance validated by a medical professional?

Alternate names

extensions, user content

Definition

Extension that is used to indicate whether the entire instance has been validated.

Comments

Data type

Extension(CodeableConcept)

Extension URL

https://fhir.stichting-nice.nl/STU3/StructureDefinition/NICE-Verified-2022Q1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

modifierExtension

?! I

0..*

Extension

There are no (further) constraints on this element

Element id

PractitionerRole.modifierExtension

Short description

Extensions that cannot be ignored

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Sliced:

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

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
hcim-basicelements-v1.0-2017EN: NL-CM:0.0.6

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

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

Σ I

0..1

Reference(nl-core-practitioner)

There are no (further) constraints on this element

Element id

PractitionerRole.practitioner

Short description

Practitioner that is able to provide the defined services for the organation

Definition

Practitioner that is able to provide the defined services for the organation.

Comments

Data type

Reference(nl-core-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

Σ I

0..1

Reference(nl-core-organization)

There are no (further) constraints on this element

Element id

PractitionerRole.organization

Short description

HealthcareProvider

Alternate names

Zorgaanbieder

Definition

The organization where the Practitioner performs the roles associated.

Comments

Data type

Reference(nl-core-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
hcim-healthprofessional-v1.2.1-2015EN: NL-CM:17.1.6
hcim-healthprofessional-v3.0-2016EN: NL-CM:17.1.6
hcim-healthprofessional-v3.2-2017EN: NL-CM:17.1.6

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

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..1

CodeableConceptBinding

Element id

PractitionerRole.specialty

Short description

Specialty

Alternate names

Specialisme

Definition

For NICE the SpecialtyAGB coding is required in order to submit the 'Referring Specialism' data element.

Comments

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
hcim-healthprofessional-v1.2.1-2015EN: NL-CM:17.1.4
hcim-healthprofessional-v3.0-2016EN: NL-CM:17.1.4
hcim-healthprofessional-v3.2-2017EN: NL-CM:17.1.4
NICE-Datadictionary-MDS: https://www.stichting-nice.nl/dd/#356

0..1

string

There are no (further) constraints on this element

Element id

PractitionerRole.specialty.id

Short description

xml:id (or equivalent in JSON)

Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

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

extension

0..*

Extension

There are no (further) constraints on this element

Element id

PractitionerRole.specialty.extension

Short description

Additional Content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Sliced:

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

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

Data type

Coding

Sliced:

Unordered, Open, by system(Value)

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: C*E.1-8, C*E.10-22
rim: union(., ./translation)
orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding

SpecialtyUZI

0..*

CodingBinding

There are no (further) constraints on this element

Element id

PractitionerRole.specialty.coding:SpecialtyUZI

Short description

SpecialtyUZI

Alternate names

SpecialismeUZI

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

Data type

Coding

Binding

SpecialismeUZICodelijst (required)

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: C*E.1-8, C*E.10-22
rim: union(., ./translation)
orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding

0..1

string

There are no (further) constraints on this element

Element id

PractitionerRole.specialty.coding:SpecialtyUZI.id

Short description

xml:id (or equivalent in JSON)

Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

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

extension

0..*

Extension

There are no (further) constraints on this element

Element id

PractitionerRole.specialty.coding:SpecialtyUZI.extension

Short description

Additional Content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Sliced:

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

system

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

PractitionerRole.specialty.coding:SpecialtyUZI.system

Short description

Identity of the terminology system

Definition

The identification of the code system that defines the meaning of the symbol in the code.

Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

Data type

uri

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())

Fixed value

http://fhir.nl/fhir/NamingSystem/uzi-rolcode

Mappings

rim: n/a
v2: C*E.3
rim: ./codeSystem
orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem

version

0..1

string

There are no (further) constraints on this element

Element id

PractitionerRole.specialty.coding:SpecialtyUZI.version

Short description

Version of the system - if relevant

Definition

Comments

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: C*E.7
rim: ./codeSystemVersion
orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion

code

0..1

code

There are no (further) constraints on this element

Element id

PractitionerRole.specialty.coding:SpecialtyUZI.code

Short description

Symbol in syntax defined by the system

Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Requirements

Need to refer to a particular code in the system.

Comments

Note that FHIR strings may not exceed 1MB in size

Data type

code

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())

Mappings

rim: n/a
v2: C*E.1
rim: ./code
orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code

display

0..1

string

There are no (further) constraints on this element

Element id

PractitionerRole.specialty.coding:SpecialtyUZI.display

Short description

Representation defined by the system

Definition

A representation of the meaning of the code in the system, following the rules of the system.

Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

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
v2: C*E.2 - but note this is not well followed
rim: CV.displayName
orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName

userSelected

0..1

boolean

There are no (further) constraints on this element

Element id

PractitionerRole.specialty.coding:SpecialtyUZI.userSelected

Short description

If this coding was chosen directly by the user

Definition

Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays).

Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Data type

boolean

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())

Mappings

rim: n/a
v2: Sometimes implied by being first
rim: CD.codingRationale
orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]

SpecialtyAGB

S Σ

0..*

CodingBinding

Element id

PractitionerRole.specialty.coding:SpecialtyAGB

Short description

SpecialtyAGB

Alternate names

SpecialismeAGB

Definition

The AGB-code (Algemeen GegevensBeheer, or general datamanagement in English) is an unique code that identifies Dutch healthcareproviders. There are three types of AGB-codes:

Specialty-related;
Person-related;
And institution-related.

To identify the referring specialism (NICE data element) only specialty-related codes are required. For example, 0320 (Cardiology)

Requirements

Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.

Comments

Data type

Coding

Binding

SpecialismeAGBCodelijst (required)

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: C*E.1-8, C*E.10-22
rim: union(., ./translation)
orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding

0..1

string

There are no (further) constraints on this element

Element id

PractitionerRole.specialty.coding:SpecialtyAGB.id

Short description

xml:id (or equivalent in JSON)

Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

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

extension

0..*

Extension

There are no (further) constraints on this element

Element id

PractitionerRole.specialty.coding:SpecialtyAGB.extension

Short description

Additional Content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Sliced:

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

system

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

PractitionerRole.specialty.coding:SpecialtyAGB.system

Short description

Identity of the terminology system

Definition

The identification of the code system that defines the meaning of the symbol in the code.

Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

Data type

uri

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())

Fixed value

urn:oid:2.16.840.1.113883.2.4.6.7

Mappings

rim: n/a
v2: C*E.3
rim: ./codeSystem
orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem

version

0..1

string

There are no (further) constraints on this element

Element id

PractitionerRole.specialty.coding:SpecialtyAGB.version

Short description

Version of the system - if relevant

Definition

Comments

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: C*E.7
rim: ./codeSystemVersion
orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion

code

0..1

code

There are no (further) constraints on this element

Element id

PractitionerRole.specialty.coding:SpecialtyAGB.code

Short description

Symbol in syntax defined by the system

Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Requirements

Need to refer to a particular code in the system.

Comments

Note that FHIR strings may not exceed 1MB in size

Data type

code

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())

Mappings

rim: n/a
v2: C*E.1
rim: ./code
orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code

display

0..1

string

There are no (further) constraints on this element

Element id

PractitionerRole.specialty.coding:SpecialtyAGB.display

Short description

Representation defined by the system

Definition

A representation of the meaning of the code in the system, following the rules of the system.

Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

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
v2: C*E.2 - but note this is not well followed
rim: CV.displayName
orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName

userSelected

0..1

boolean

There are no (further) constraints on this element

Element id

PractitionerRole.specialty.coding:SpecialtyAGB.userSelected

Short description

If this coding was chosen directly by the user

Definition

Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays).

Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Data type

boolean

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())

Mappings

rim: n/a
v2: Sometimes implied by being first
rim: CD.codingRationale
orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]

text

0..1

string

There are no (further) constraints on this element

Element id

PractitionerRole.specialty.text

Short description

Plain text representation of the concept

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

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: C*E.9. But note many systems use C*E.2 for this
rim: ./originalText[mediaType/code="text/plain"]/data
orim: fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText

location

Σ I

0..*

Reference(Location)

There are no (further) constraints on this element

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

Data type

Reference(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

0..*

Reference(HealthcareService)

There are no (further) constraints on this element

Element id

PractitionerRole.healthcareService

Short description

The list of healthcare services that this worker provides for this role's Organization/Location(s)

Definition

The list of healthcare services that this worker provides for this role's Organization/Location(s).

Comments

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

telecom

Σ I

0..*

nl-core-contactpoint

There are no (further) constraints on this element

Element id

PractitionerRole.telecom

Short description

ContactInformation

Alternate names

Contactgegevens

Definition

HCIM	`.ext:TelecomType`	`.system`	`.use`
Primary Home Land Line	LL	phone	home
Temporary Land Line	LL	phone	temp
Primary Work Land Line	LL	phone	work

Primary Home Fax	FAX	fax	home
Temporary Fax	FAX	fax	temp
Primary Work Fax	FAX	fax	work

Primary Home Mobile Phone	MC	phone	home
Temporary Mobile Phone	MC	phone	temp
Primary Work Mobile Phone	MC	phone	work

Primary Home Pager	PG	pager	home
Temporary Pager	PG	pager	temp
Primary Work Pager	PG	pager	work

Private email address		email	home
Work email address		email	work

Mobile phone number undetermined private/business		phone	mobile

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

nl-core-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()

Examples

Mobile business phone number. Note: the mobile nature stems from the number being an 06-* number.

{
  "system": "phone",
  "value": "+31611234567",
  "use": "work"
}

Mobile phone number undetermined private/business. Note: the mobile nature stems from the number being an 06-* number.

{
  "system": "phone",
  "value": "+31611234567",
  "use": "mobile"
}

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"
}

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"
}

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"
}

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"
}

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"
}

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"
}

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"
}

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"
}

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"
}

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"
}

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"
}

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"
}

Private email address

{
  "system": "email",
  "value": "giesput@myweb.nl",
  "use": "home"
}

Work email address

{
  "system": "email",
  "value": "example@workplace.nl",
  "use": "work"
}

Mappings

rim: n/a
v2: XTN
rim: TEL
servd: ContactPoint
rim: .telecom
hcim-contactinformation-v2.0.1-2015EN: NL-CM:0.1.5
hcim-contactinformation-v3.0-2016EN: NL-CM:0.1.5
hcim-contactinformation-v1.0-2017EN: NL-CM:20.6.1
hcim-healthprofessional-v1.2.1-2015EN: NL-CM:17.1.8
hcim-healthprofessional-v3.0-2016EN: NL-CM:17.1.8
hcim-healthprofessional-v3.2-2017EN: NL-CM:17.1.8

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

0..1

string

There are no (further) constraints on this element

Element id

PractitionerRole.availableTime.id

Short description

xml:id (or equivalent in JSON)

Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

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

extension

0..*

Extension

There are no (further) constraints on this element

Element id

PractitionerRole.availableTime.extension

Short description

Additional Content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Sliced:

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

modifierExtension

Σ ?! I

0..*

Extension

There are no (further) constraints on this element

Element id

PractitionerRole.availableTime.modifierExtension

Short description

Extensions that cannot be ignored

Alternate names

extensions, user content, modifiers

Definition

Comments

Data type

Extension

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

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

0..1

string

There are no (further) constraints on this element

Element id

PractitionerRole.notAvailable.id

Short description

xml:id (or equivalent in JSON)

Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

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

extension

0..*

Extension

There are no (further) constraints on this element

Element id

PractitionerRole.notAvailable.extension

Short description

Additional Content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Sliced:

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

modifierExtension

Σ ?! I

0..*

Extension

There are no (further) constraints on this element

Element id

PractitionerRole.notAvailable.modifierExtension

Short description

Extensions that cannot be ignored

Alternate names

extensions, user content, modifiers

Definition

Comments

Data type

Extension

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

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

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

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

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

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

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)

PractitionerRole

Element id

PractitionerRole

Short description

HealthProfessionalRole

Alternate names

ZorgverlenerRol

Definition

A specific set of Roles/Locations/specialties/services that a practitioner may perform at an organization for a period of time.

This profile should be used to submit the AGB specialty codes of the PractitionerRole. Other attributes of a PractitionerRole are not processed by NICE and do not need to be sent.

More information can be found in the NICE datadictionary: https://www.stichting-nice.nl/dd/#356

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

0..1

There are no (further) constraints on this element

Element id

PractitionerRole.id

Short description

Logical id of this artifact

Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

Comments

The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

Data type

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())

Mappings

rim: n/a

Meta

There are no (further) constraints on this element

Element id

PractitionerRole.meta

Short description

Metadata about the resource

Definition

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource.

Data type

Meta

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())

Mappings

rim: n/a
rim: N/A

implicitRules

Σ ?!

0..1

uri

There are no (further) constraints on this element

Element id

PractitionerRole.implicitRules

Short description

A set of rules under which this content was created

Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.

Comments

This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.

Data type

uri

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())

Mappings

rim: n/a

language

0..1

codeBinding

There are no (further) constraints on this element

Element id

PractitionerRole.language

Short description

Language of the resource content

Definition

The base language in which the resource is written.

Comments

Data type

code

Binding

A human language.

Common Languages (extensible)

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())

Mappings

rim: n/a

text

0..1

Narrative

There are no (further) constraints on this element

Element id

PractitionerRole.text

Short description

Text summary of the resource, for human interpretation

Alternate names

narrative, html, xhtml, display

Definition

Comments

Data type

Narrative

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())

Mappings

rim: n/a
rim: N/A
rim: Act.text?

contained

0..*

Resource

There are no (further) constraints on this element

Element id

PractitionerRole.contained

Short description

Contained, inline Resources

Alternate names

inline resources, anonymous resources, contained resources

Definition

Comments

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.

Data type

Resource

Mappings

rim: Entity. Role, or Act
rim: N/A

extension

1..*

Extension

There are no (further) constraints on this element

Element id

PractitionerRole.extension

Short description

Additional Content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Sliced:

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

Verified

S I

1..1

Extension(CodeableConcept)

Element id

PractitionerRole.extension:Verified

Short description

Is the instance validated by a medical professional?

Alternate names

extensions, user content

Definition

Extension that is used to indicate whether the entire instance has been validated.

Comments

Data type

Extension(CodeableConcept)

Extension URL

https://fhir.stichting-nice.nl/STU3/StructureDefinition/NICE-Verified-2022Q1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

modifierExtension

?! I

0..*

Extension

There are no (further) constraints on this element

Element id

PractitionerRole.modifierExtension

Short description

Extensions that cannot be ignored

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Sliced:

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

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
hcim-basicelements-v1.0-2017EN: NL-CM:0.0.6

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

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

Σ I

0..1

Reference(nl-core-practitioner)

There are no (further) constraints on this element

Element id

PractitionerRole.practitioner

Short description

Practitioner that is able to provide the defined services for the organation

Definition

Practitioner that is able to provide the defined services for the organation.

Comments

Data type

Reference(nl-core-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

Σ I

0..1

Reference(nl-core-organization)

There are no (further) constraints on this element

Element id

PractitionerRole.organization

Short description

HealthcareProvider

Alternate names

Zorgaanbieder

Definition

The organization where the Practitioner performs the roles associated.

Comments

Data type

Reference(nl-core-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
hcim-healthprofessional-v1.2.1-2015EN: NL-CM:17.1.6
hcim-healthprofessional-v3.0-2016EN: NL-CM:17.1.6
hcim-healthprofessional-v3.2-2017EN: NL-CM:17.1.6

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

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..1

CodeableConceptBinding

Element id

PractitionerRole.specialty

Short description

Specialty

Alternate names

Specialisme

Definition

For NICE the SpecialtyAGB coding is required in order to submit the 'Referring Specialism' data element.

Comments

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
hcim-healthprofessional-v1.2.1-2015EN: NL-CM:17.1.4
hcim-healthprofessional-v3.0-2016EN: NL-CM:17.1.4
hcim-healthprofessional-v3.2-2017EN: NL-CM:17.1.4
NICE-Datadictionary-MDS: https://www.stichting-nice.nl/dd/#356

0..1

string

There are no (further) constraints on this element

Element id

PractitionerRole.specialty.id

Short description

xml:id (or equivalent in JSON)

Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

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

extension

0..*

Extension

There are no (further) constraints on this element

Element id

PractitionerRole.specialty.extension

Short description

Additional Content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Sliced:

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

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

Data type

Coding

Sliced:

Unordered, Open, by system(Value)

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: C*E.1-8, C*E.10-22
rim: union(., ./translation)
orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding

SpecialtyUZI

0..*

CodingBinding

There are no (further) constraints on this element

Element id

PractitionerRole.specialty.coding:SpecialtyUZI

Short description

SpecialtyUZI

Alternate names

SpecialismeUZI

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

Data type

Coding

Binding

SpecialismeUZICodelijst (required)

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: C*E.1-8, C*E.10-22
rim: union(., ./translation)
orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding

0..1

string

There are no (further) constraints on this element

Element id

PractitionerRole.specialty.coding:SpecialtyUZI.id

Short description

xml:id (or equivalent in JSON)

Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

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

extension

0..*

Extension

There are no (further) constraints on this element

Element id

PractitionerRole.specialty.coding:SpecialtyUZI.extension

Short description

Additional Content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Sliced:

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

system

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

PractitionerRole.specialty.coding:SpecialtyUZI.system

Short description

Identity of the terminology system

Definition

The identification of the code system that defines the meaning of the symbol in the code.

Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

Data type

uri

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())

Fixed value

http://fhir.nl/fhir/NamingSystem/uzi-rolcode

Mappings

rim: n/a
v2: C*E.3
rim: ./codeSystem
orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem

version

0..1

string

There are no (further) constraints on this element

Element id

PractitionerRole.specialty.coding:SpecialtyUZI.version

Short description

Version of the system - if relevant

Definition

Comments

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: C*E.7
rim: ./codeSystemVersion
orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion

code

0..1

code

There are no (further) constraints on this element

Element id

PractitionerRole.specialty.coding:SpecialtyUZI.code

Short description

Symbol in syntax defined by the system

Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Requirements

Need to refer to a particular code in the system.

Comments

Note that FHIR strings may not exceed 1MB in size

Data type

code

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())

Mappings

rim: n/a
v2: C*E.1
rim: ./code
orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code

display

0..1

string

There are no (further) constraints on this element

Element id

PractitionerRole.specialty.coding:SpecialtyUZI.display

Short description

Representation defined by the system

Definition

A representation of the meaning of the code in the system, following the rules of the system.

Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

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
v2: C*E.2 - but note this is not well followed
rim: CV.displayName
orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName

userSelected

0..1

boolean

There are no (further) constraints on this element

Element id

PractitionerRole.specialty.coding:SpecialtyUZI.userSelected

Short description

If this coding was chosen directly by the user

Definition

Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays).

Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Data type

boolean

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())

Mappings

rim: n/a
v2: Sometimes implied by being first
rim: CD.codingRationale
orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]

SpecialtyAGB

S Σ

0..*

CodingBinding

Element id

PractitionerRole.specialty.coding:SpecialtyAGB

Short description

SpecialtyAGB

Alternate names

SpecialismeAGB

Definition

The AGB-code (Algemeen GegevensBeheer, or general datamanagement in English) is an unique code that identifies Dutch healthcareproviders. There are three types of AGB-codes:

Specialty-related;
Person-related;
And institution-related.

To identify the referring specialism (NICE data element) only specialty-related codes are required. For example, 0320 (Cardiology)

Requirements

Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.

Comments

Data type

Coding

Binding

SpecialismeAGBCodelijst (required)

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: C*E.1-8, C*E.10-22
rim: union(., ./translation)
orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding

0..1

string

There are no (further) constraints on this element

Element id

PractitionerRole.specialty.coding:SpecialtyAGB.id

Short description

xml:id (or equivalent in JSON)

Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

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

extension

0..*

Extension

There are no (further) constraints on this element

Element id

PractitionerRole.specialty.coding:SpecialtyAGB.extension

Short description

Additional Content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Sliced:

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

system

1..1

uriFixed Value

There are no (further) constraints on this element

Element id

PractitionerRole.specialty.coding:SpecialtyAGB.system

Short description

Identity of the terminology system

Definition

The identification of the code system that defines the meaning of the symbol in the code.

Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

Data type

uri

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())

Fixed value

urn:oid:2.16.840.1.113883.2.4.6.7

Mappings

rim: n/a
v2: C*E.3
rim: ./codeSystem
orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem

version

0..1

string

There are no (further) constraints on this element

Element id

PractitionerRole.specialty.coding:SpecialtyAGB.version

Short description

Version of the system - if relevant

Definition

Comments

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: C*E.7
rim: ./codeSystemVersion
orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion

code

0..1

code

There are no (further) constraints on this element

Element id

PractitionerRole.specialty.coding:SpecialtyAGB.code

Short description

Symbol in syntax defined by the system

Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Requirements

Need to refer to a particular code in the system.

Comments

Note that FHIR strings may not exceed 1MB in size

Data type

code

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())

Mappings

rim: n/a
v2: C*E.1
rim: ./code
orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code

display

0..1

string

There are no (further) constraints on this element

Element id

PractitionerRole.specialty.coding:SpecialtyAGB.display

Short description

Representation defined by the system

Definition

A representation of the meaning of the code in the system, following the rules of the system.

Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

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
v2: C*E.2 - but note this is not well followed
rim: CV.displayName
orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName

userSelected

0..1

boolean

There are no (further) constraints on this element

Element id

PractitionerRole.specialty.coding:SpecialtyAGB.userSelected

Short description

If this coding was chosen directly by the user

Definition

Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays).

Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Data type

boolean

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())

Mappings

rim: n/a
v2: Sometimes implied by being first
rim: CD.codingRationale
orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]

text

0..1

string

There are no (further) constraints on this element

Element id

PractitionerRole.specialty.text

Short description

Plain text representation of the concept

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

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: C*E.9. But note many systems use C*E.2 for this
rim: ./originalText[mediaType/code="text/plain"]/data
orim: fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText

location

Σ I

0..*

Reference(Location)

There are no (further) constraints on this element

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

Data type

Reference(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

0..*

Reference(HealthcareService)

There are no (further) constraints on this element

Element id

PractitionerRole.healthcareService

Short description

The list of healthcare services that this worker provides for this role's Organization/Location(s)

Definition

The list of healthcare services that this worker provides for this role's Organization/Location(s).

Comments

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

telecom

Σ I

0..*

nl-core-contactpoint

There are no (further) constraints on this element

Element id

PractitionerRole.telecom

Short description

ContactInformation

Alternate names

Contactgegevens

Definition

HCIM	`.ext:TelecomType`	`.system`	`.use`
Primary Home Land Line	LL	phone	home
Temporary Land Line	LL	phone	temp
Primary Work Land Line	LL	phone	work

Primary Home Fax	FAX	fax	home
Temporary Fax	FAX	fax	temp
Primary Work Fax	FAX	fax	work

Primary Home Mobile Phone	MC	phone	home
Temporary Mobile Phone	MC	phone	temp
Primary Work Mobile Phone	MC	phone	work

Primary Home Pager	PG	pager	home
Temporary Pager	PG	pager	temp
Primary Work Pager	PG	pager	work

Private email address		email	home
Work email address		email	work

Mobile phone number undetermined private/business		phone	mobile

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

nl-core-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()

Examples

Mobile business phone number. Note: the mobile nature stems from the number being an 06-* number.

{
  "system": "phone",
  "value": "+31611234567",
  "use": "work"
}

Mobile phone number undetermined private/business. Note: the mobile nature stems from the number being an 06-* number.

{
  "system": "phone",
  "value": "+31611234567",
  "use": "mobile"
}

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"
}

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"
}

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"
}

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"
}

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"
}

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"
}

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"
}

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"
}

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"
}

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"
}

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"
}

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"
}

Private email address

{
  "system": "email",
  "value": "giesput@myweb.nl",
  "use": "home"
}

Work email address

{
  "system": "email",
  "value": "example@workplace.nl",
  "use": "work"
}

Mappings

rim: n/a
v2: XTN
rim: TEL
servd: ContactPoint
rim: .telecom
hcim-contactinformation-v2.0.1-2015EN: NL-CM:0.1.5
hcim-contactinformation-v3.0-2016EN: NL-CM:0.1.5
hcim-contactinformation-v1.0-2017EN: NL-CM:20.6.1
hcim-healthprofessional-v1.2.1-2015EN: NL-CM:17.1.8
hcim-healthprofessional-v3.0-2016EN: NL-CM:17.1.8
hcim-healthprofessional-v3.2-2017EN: NL-CM:17.1.8

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

0..1

string

There are no (further) constraints on this element

Element id

PractitionerRole.availableTime.id

Short description

xml:id (or equivalent in JSON)

Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

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

extension

0..*

Extension

There are no (further) constraints on this element

Element id

PractitionerRole.availableTime.extension

Short description

Additional Content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Sliced:

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

modifierExtension

Σ ?! I

0..*

Extension

There are no (further) constraints on this element

Element id

PractitionerRole.availableTime.modifierExtension

Short description

Extensions that cannot be ignored

Alternate names

extensions, user content, modifiers

Definition

Comments

Data type

Extension

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

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

0..1

string

There are no (further) constraints on this element

Element id

PractitionerRole.notAvailable.id

Short description

xml:id (or equivalent in JSON)

Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

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

extension

0..*

Extension

There are no (further) constraints on this element

Element id

PractitionerRole.notAvailable.extension

Short description

Additional Content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Sliced:

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

modifierExtension

Σ ?! I

0..*

Extension

There are no (further) constraints on this element

Element id

PractitionerRole.notAvailable.modifierExtension

Short description

Extensions that cannot be ignored

Alternate names

extensions, user content, modifiers

Definition

Comments

Data type

Extension

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

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

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

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

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

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

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)

Mapping FHIR profile NICE data dictionary

Path	identity	map	comment
PractitionerRole.specialty	NICE-Datadictionary-MDS	https://www.stichting-nice.nl/dd/#356	Referring Specialism

{
    "resourceType": "PractitionerRole",
    "id": "NICE-PractitionerRole-Example-01",
    "meta": {
        "profile":  [
            "https://fhir.stichting-nice.nl/STU3/StructureDefinition/NICE-PractitionerRole-2022Q1"
        ]
    },
    "text": {
        --- We have skipped the narrative for better readability of the resource ---
    },
    "extension":  [
        {
            "url": "https://fhir.stichting-nice.nl/STU3/StructureDefinition/NICE-Verified-2022Q1",
            "valueCodeableConcept": {
                "coding":  [
                    {
                        "system": "http://terminology.hl7.org/ValueSet/v2-0532",
                        "code": "Y",
                        "display": "Yes"
                    }
                ]
            }
        }
    ],
    "organization": {
        "reference": "Organization/nl-core-organization-01",
        "display": "Amsterdam UMC - Locatie VUmc"
    },
    "specialty":  [
        {
            "coding":  [
                {
                    "system": "urn:oid:2.16.840.1.113883.2.4.6.7",
                    "code": "0320",
                    "display": "Medisch specialisten, cardiologie"
                }
            ]
        }
    ]
}

<PractitionerRole xmlns="http://hl7.org/fhir">
    <id value="NICE-PractitionerRole-Example-01" />
    <meta>
        <profile value="https://fhir.stichting-nice.nl/STU3/StructureDefinition/NICE-PractitionerRole-2022Q1" />
    </meta>
    <text>
        <status />
        --- We have skipped the narrative for better readability of the resource ---
    </text>
    <extension url="https://fhir.stichting-nice.nl/STU3/StructureDefinition/NICE-Verified-2022Q1">
        <valueCodeableConcept>
            <coding>
                <system value="http://terminology.hl7.org/ValueSet/v2-0532" />
                <code value="Y" />
                <display value="Yes" />
            </coding>
        </valueCodeableConcept>
    </extension>
    <organization>
        <reference value="Organization/nl-core-organization-01" />
        <display value="Amsterdam UMC - Locatie VUmc" />
    </organization>
    <specialty>
        <coding>
            <system value="urn:oid:2.16.840.1.113883.2.4.6.7" />
            <code value="0320" />
            <display value="Medisch specialisten, cardiologie" />
        </coding>
    </specialty>
</PractitionerRole>