HL7 PT FHIR Implementation Guide: Visita do Utente
1.0.0 - STU1 Portugal flag

HL7 PT FHIR Implementation Guide: Visita do Utente, published by HL7 Portugal. This guide is not an authorized publication; it is the continuous build for version 1.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7-pt/workflow-ep-ig/tree/master and changes regularly. See the Directory of published versions

Resource Profile: PT_PractitionerRole

Official URL: https://hl7.pt/fhir/patient-visit/StructureDefinition/PTPractitionerRole Version: 1.0.0
Active as of 2021-12-20 Computable Name: PT_PractitionerRole

Este recurso é fundamental para mapear com precisão os papéis desempenhados por profissionais em diferentes contextos, garantindo uma atribuição clara de responsabilidades e rastreabilidade em sistemas clínicos e administrativos.

Usage:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraintsdoco
.. PractitionerRole 0..* PractitionerRole Roles/organizations the practitioner is associated with
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
dom-6: A resource should have narrative for robust management
... meta Σ 0..1 Meta Metadata about the resource
ele-1: All FHIR elements must have a @value or children
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... identifier Σ 0..* Identifier Business Identifiers that are specific to a role/location
ele-1: All FHIR elements must have a @value or children
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


ele-1: All FHIR elements must have a @value or children
.... type Σ 0..1 CodeableConcept Description of identifier
Binding: hl7VS-identifierType (extensible)
ele-1: All FHIR elements must have a @value or children
.... system Σ 0..1 uri The namespace for the identifier value
ele-1: All FHIR elements must have a @value or children
Example General: http://www.acme.com/identifiers/patient
.... value Σ 0..1 string The value that is unique
ele-1: All FHIR elements must have a @value or children
Example General: 123456
... period Σ 0..1 Period The period during which the practitioner is authorized to perform in these role(s)
ele-1: All FHIR elements must have a @value or children
.... start ΣC 0..1 dateTime Starting time with inclusive boundary
ele-1: All FHIR elements must have a @value or children
.... end ΣC 0..1 dateTime End time with inclusive boundary, if not ongoing
ele-1: All FHIR elements must have a @value or children
... practitioner Σ 0..1 Reference(PT_Practitioner) Practitioner that is able to provide the defined services for the organization
ele-1: All FHIR elements must have a @value or children
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
ele-1: All FHIR elements must have a @value or children
... Slices for code Σ 0..* CodeableConcept Roles which this practitioner may perform
Slice: Unordered, Open by pattern:$this
Binding: PractitionerRole (example): The role a person plays representing an organization.


ele-1: All FHIR elements must have a @value or children

Example System: {"text":"SNOMED"}
.... code:All Slices Content/Rules for all slices
.... code:healthcareProfessionalRoles Σ 0..* CodeableConcept Roles which this practitioner may perform
Binding: Healthcare Professional Roles - IPS (required): IPS Healthcare Professional Roles


ele-1: All FHIR elements must have a @value or children
..... text Σ 0..1 string Plain text representation of the concept
ele-1: All FHIR elements must have a @value or children
... specialty Σ 0..* CodeableConcept Specific specialty of the practitioner
Binding: PracticeSettingCodeValueSet (preferred): Specific specialty associated with the agency.


ele-1: All FHIR elements must have a @value or children
... location Σ 0..* Reference(PT_Location) The location(s) at which this practitioner provides care
ele-1: All FHIR elements must have a @value or children
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
ele-1: All FHIR elements must have a @value or children
... telecom Σ 0..* ContactPoint Contact details that are specific to the role/location/service
ele-1: All FHIR elements must have a @value or children
.... system ΣC 0..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


ele-1: All FHIR elements must have a @value or children
.... value Σ 0..1 string The actual contact point details
ele-1: All FHIR elements must have a @value or children
.... use ?!Σ 0..1 code ASN | WPN - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.


ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
PractitionerRole.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
PractitionerRole.identifier.typeextensibleHl7VSIdentifierType
http://terminology.hl7.org/ValueSet/v2-0203
PractitionerRole.codeexamplePractitionerRole
http://hl7.org/fhir/ValueSet/practitioner-role
from the FHIR Standard
PractitionerRole.code:healthcareProfessionalRolesrequiredHealthcareProfessionalRolesUvIps (a valid code from urn:oid:2.16.840.1.113883.2.9.6.2.7)
http://hl7.org/fhir/uv/ips/ValueSet/healthcare-professional-roles-uv-ips
PractitionerRole.specialtypreferredPracticeSettingCodeValueSet
http://hl7.org/fhir/ValueSet/c80-practice-codes
from the FHIR Standard
PractitionerRole.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
PractitionerRole.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorPractitionerRoleIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorPractitionerRoleIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorPractitionerRoleIf 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-5errorPractitionerRoleIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practicePractitionerRoleA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from PractitionerRole

NameFlagsCard.TypeDescription & Constraintsdoco
.. PractitionerRole PractitionerRole
... meta 0..1 Meta Metadata about the resource
.... id 0..0
.... versionId 0..0
.... source 0..0
.... profile 0..0
.... security 0..0
.... tag 0..0
... implicitRules 0..0
... language 0..0
... contained 0..0
... identifier 0..* Identifier Business Identifiers that are specific to a role/location
.... id 0..0
.... type 0..1 CodeableConcept Description of identifier
Binding: hl7VS-identifierType (extensible)
..... id 0..0
..... coding
...... id 0..0
...... version 0..0
...... code 0..1 code Symbol in syntax defined by the system
...... userSelected 0..0
..... text 0..0
.... system 0..1 uri The namespace for the identifier value
.... value 0..1 string The value that is unique
.... period
..... id 0..0
..... end 0..1 dateTime End time with inclusive boundary, if not ongoing
.... assigner 0..0
... active 0..1 boolean Whether this practitioner role record is in active use
... period 0..1 Period The period during which the practitioner is authorized to perform in these role(s)
.... id 0..0
.... start 0..1 dateTime Starting time with inclusive boundary
.... end 0..1 dateTime End time with inclusive boundary, if not ongoing
... practitioner 0..1 Reference(PT_Practitioner) Practitioner that is able to provide the defined services for the organization
.... id 0..0
.... reference 0..1 string Literal reference, Relative, internal or absolute URL
.... type 0..0
.... identifier 0..0
.... display 0..0
... organization
.... id 0..0
.... reference 0..1 string Literal reference, Relative, internal or absolute URL
.... type 0..0
.... identifier 0..0
.... display 0..0
... Slices for code 0..* CodeableConcept Roles which this practitioner may perform
Slice: Unordered, Open by pattern:$this
Example System: {"text":"SNOMED"}
.... code:All Slices Content/Rules for all slices
..... id 0..0
..... coding 0..0
..... text 0..0
.... code:healthcareProfessionalRoles 0..* CodeableConcept Roles which this practitioner may perform
Binding: Healthcare Professional Roles - IPS (required): IPS Healthcare Professional Roles

..... id 0..0
..... coding
...... id 0..0
...... system 0..1 uri Identity of the terminology system
Example System: http://data.europa.eu/isco/isco-08
...... version 0..0
...... code 0..1 code Symbol in syntax defined by the system
...... display 0..1 string Representation defined by the system
...... userSelected 0..0
..... text 0..1 string Plain text representation of the concept
... specialty 0..* CodeableConcept Specific specialty of the practitioner
.... id 0..0
.... coding
..... id 0..0
..... system 0..1 uri Identity of the terminology system
Example System: SNOMED
..... version 0..0
..... code 0..1 code Symbol in syntax defined by the system
..... display 0..1 string Representation defined by the system
..... userSelected 0..0
.... text 0..0
... location 0..* Reference(PT_Location) The location(s) at which this practitioner provides care
.... id 0..0
.... reference 0..1 string Literal reference, Relative, internal or absolute URL
.... type 0..0
.... identifier 0..0
.... display 0..0
... healthcareService
.... id 0..0
.... reference 0..1 string Literal reference, Relative, internal or absolute URL
.... type 0..0
.... identifier 0..0
.... display 0..0
... telecom 0..* ContactPoint Contact details that are specific to the role/location/service
.... id 0..0
.... system 0..1 code phone | fax | email | pager | url | sms | other
.... value 0..1 string The actual contact point details
.... use 0..1 code ASN | WPN - purpose of this contact point
.... rank 0..0
.... period 0..0
... availableTime
.... id 0..0
... notAvailable
.... id 0..0
... availabilityExceptions 0..0
... endpoint 0..0

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
PractitionerRole.identifier.typeextensibleHl7VSIdentifierType
http://terminology.hl7.org/ValueSet/v2-0203
PractitionerRole.code:healthcareProfessionalRolesrequiredHealthcareProfessionalRolesUvIps (a valid code from urn:oid:2.16.840.1.113883.2.9.6.2.7)
http://hl7.org/fhir/uv/ips/ValueSet/healthcare-professional-roles-uv-ips
NameFlagsCard.TypeDescription & Constraintsdoco
.. PractitionerRole 0..* PractitionerRole Roles/organizations the practitioner is associated with
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... lastUpdated Σ 0..1 instant When the resource version last changed
... extension 0..* Extension Additional content defined by implementations
... identifier Σ 0..* Identifier Business Identifiers that are specific to a role/location
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... type Σ 0..1 CodeableConcept Description of identifier
Binding: hl7VS-identifierType (extensible)
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ 0..* Coding Code defined by a terminology system
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ 0..1 uri Identity of the terminology system
...... code Σ 0..1 code Symbol in syntax defined by the system
...... display Σ 0..1 string Representation defined by the system
.... system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value Σ 0..1 string The value that is unique
Example General: 123456
.... period Σ 0..1 Period Time period when id is/was valid for use
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... start ΣC 0..1 dateTime Starting time with inclusive boundary
..... end ΣC 0..1 dateTime End time with inclusive boundary, if not ongoing
... active Σ 0..1 boolean Whether this practitioner role record is in active use
... period Σ 0..1 Period The period during which the practitioner is authorized to perform in these role(s)
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... start ΣC 0..1 dateTime Starting time with inclusive boundary
.... end ΣC 0..1 dateTime End time with inclusive boundary, if not ongoing
... practitioner Σ 0..1 Reference(PT_Practitioner) Practitioner that is able to provide the defined services for the organization
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
... organization Σ 0..1 Reference(Organization) Organization where the roles are available
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
... Slices for code Σ 0..* CodeableConcept Roles which this practitioner may perform
Slice: Unordered, Open by pattern:$this
Binding: PractitionerRole (example): The role a person plays representing an organization.



Example System: {"text":"SNOMED"}
.... code:All Slices Content/Rules for all slices
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... code:healthcareProfessionalRoles Σ 0..* CodeableConcept Roles which this practitioner may perform
Binding: Healthcare Professional Roles - IPS (required): IPS Healthcare Professional Roles


..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ 0..* Coding Code defined by a terminology system
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ 0..1 uri Identity of the terminology system
Example System: http://data.europa.eu/isco/isco-08
...... code Σ 0..1 code Symbol in syntax defined by the system
...... display Σ 0..1 string Representation defined by the system
..... text Σ 0..1 string Plain text representation of the concept
... specialty Σ 0..* CodeableConcept Specific specialty of the practitioner
Binding: PracticeSettingCodeValueSet (preferred): Specific specialty associated with the agency.


.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ 0..* Coding Code defined by a terminology system
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... system Σ 0..1 uri Identity of the terminology system
Example System: SNOMED
..... code Σ 0..1 code Symbol in syntax defined by the system
..... display Σ 0..1 string Representation defined by the system
... location Σ 0..* Reference(PT_Location) The location(s) at which this practitioner provides care
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
... healthcareService 0..* Reference(HealthcareService) The list of healthcare services that this worker provides for this role's Organization/Location(s)
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
... telecom Σ 0..* ContactPoint Contact details that are specific to the role/location/service
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... system ΣC 0..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

.... value Σ 0..1 string The actual contact point details
.... use ?!Σ 0..1 code ASN | WPN - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

... availableTime 0..* BackboneElement Times the Service Site is available
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... daysOfWeek 0..* code mon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required): The days of the week.


.... allDay 0..1 boolean Always available? e.g. 24 hour service
.... availableStartTime 0..1 time Opening time of day (ignored if allDay = true)
.... availableEndTime 0..1 time Closing time of day (ignored if allDay = true)
... notAvailable 0..* BackboneElement Not available during this time due to provided reason
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... description 1..1 string Reason presented to the user explaining why time not available
.... during 0..1 Period Service not available from this date

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
PractitionerRole.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
PractitionerRole.identifier.typeextensibleHl7VSIdentifierType
http://terminology.hl7.org/ValueSet/v2-0203
PractitionerRole.codeexamplePractitionerRole
http://hl7.org/fhir/ValueSet/practitioner-role
from the FHIR Standard
PractitionerRole.code:healthcareProfessionalRolesrequiredHealthcareProfessionalRolesUvIps (a valid code from urn:oid:2.16.840.1.113883.2.9.6.2.7)
http://hl7.org/fhir/uv/ips/ValueSet/healthcare-professional-roles-uv-ips
PractitionerRole.specialtypreferredPracticeSettingCodeValueSet
http://hl7.org/fhir/ValueSet/c80-practice-codes
from the FHIR Standard
PractitionerRole.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
PractitionerRole.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
PractitionerRole.availableTime.daysOfWeekrequiredDaysOfWeek
http://hl7.org/fhir/ValueSet/days-of-week|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorPractitionerRoleIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorPractitionerRoleIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorPractitionerRoleIf 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-5errorPractitionerRoleIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practicePractitionerRoleA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from PractitionerRole

Summary

Prohibited: 54 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of PractitionerRole.code

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. PractitionerRole 0..* PractitionerRole Roles/organizations the practitioner is associated with
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
dom-6: A resource should have narrative for robust management
... meta Σ 0..1 Meta Metadata about the resource
ele-1: All FHIR elements must have a @value or children
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... identifier Σ 0..* Identifier Business Identifiers that are specific to a role/location
ele-1: All FHIR elements must have a @value or children
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


ele-1: All FHIR elements must have a @value or children
.... type Σ 0..1 CodeableConcept Description of identifier
Binding: hl7VS-identifierType (extensible)
ele-1: All FHIR elements must have a @value or children
.... system Σ 0..1 uri The namespace for the identifier value
ele-1: All FHIR elements must have a @value or children
Example General: http://www.acme.com/identifiers/patient
.... value Σ 0..1 string The value that is unique
ele-1: All FHIR elements must have a @value or children
Example General: 123456
... period Σ 0..1 Period The period during which the practitioner is authorized to perform in these role(s)
ele-1: All FHIR elements must have a @value or children
.... start ΣC 0..1 dateTime Starting time with inclusive boundary
ele-1: All FHIR elements must have a @value or children
.... end ΣC 0..1 dateTime End time with inclusive boundary, if not ongoing
ele-1: All FHIR elements must have a @value or children
... practitioner Σ 0..1 Reference(PT_Practitioner) Practitioner that is able to provide the defined services for the organization
ele-1: All FHIR elements must have a @value or children
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
ele-1: All FHIR elements must have a @value or children
... Slices for code Σ 0..* CodeableConcept Roles which this practitioner may perform
Slice: Unordered, Open by pattern:$this
Binding: PractitionerRole (example): The role a person plays representing an organization.


ele-1: All FHIR elements must have a @value or children

Example System: {"text":"SNOMED"}
.... code:All Slices Content/Rules for all slices
.... code:healthcareProfessionalRoles Σ 0..* CodeableConcept Roles which this practitioner may perform
Binding: Healthcare Professional Roles - IPS (required): IPS Healthcare Professional Roles


ele-1: All FHIR elements must have a @value or children
..... text Σ 0..1 string Plain text representation of the concept
ele-1: All FHIR elements must have a @value or children
... specialty Σ 0..* CodeableConcept Specific specialty of the practitioner
Binding: PracticeSettingCodeValueSet (preferred): Specific specialty associated with the agency.


ele-1: All FHIR elements must have a @value or children
... location Σ 0..* Reference(PT_Location) The location(s) at which this practitioner provides care
ele-1: All FHIR elements must have a @value or children
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
ele-1: All FHIR elements must have a @value or children
... telecom Σ 0..* ContactPoint Contact details that are specific to the role/location/service
ele-1: All FHIR elements must have a @value or children
.... system ΣC 0..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.


ele-1: All FHIR elements must have a @value or children
.... value Σ 0..1 string The actual contact point details
ele-1: All FHIR elements must have a @value or children
.... use ?!Σ 0..1 code ASN | WPN - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.


ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
PractitionerRole.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
PractitionerRole.identifier.typeextensibleHl7VSIdentifierType
http://terminology.hl7.org/ValueSet/v2-0203
PractitionerRole.codeexamplePractitionerRole
http://hl7.org/fhir/ValueSet/practitioner-role
from the FHIR Standard
PractitionerRole.code:healthcareProfessionalRolesrequiredHealthcareProfessionalRolesUvIps (a valid code from urn:oid:2.16.840.1.113883.2.9.6.2.7)
http://hl7.org/fhir/uv/ips/ValueSet/healthcare-professional-roles-uv-ips
PractitionerRole.specialtypreferredPracticeSettingCodeValueSet
http://hl7.org/fhir/ValueSet/c80-practice-codes
from the FHIR Standard
PractitionerRole.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
PractitionerRole.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorPractitionerRoleIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorPractitionerRoleIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorPractitionerRoleIf 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-5errorPractitionerRoleIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practicePractitionerRoleA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Differential View

This structure is derived from PractitionerRole

NameFlagsCard.TypeDescription & Constraintsdoco
.. PractitionerRole PractitionerRole
... meta 0..1 Meta Metadata about the resource
.... id 0..0
.... versionId 0..0
.... source 0..0
.... profile 0..0
.... security 0..0
.... tag 0..0
... implicitRules 0..0
... language 0..0
... contained 0..0
... identifier 0..* Identifier Business Identifiers that are specific to a role/location
.... id 0..0
.... type 0..1 CodeableConcept Description of identifier
Binding: hl7VS-identifierType (extensible)
..... id 0..0
..... coding
...... id 0..0
...... version 0..0
...... code 0..1 code Symbol in syntax defined by the system
...... userSelected 0..0
..... text 0..0
.... system 0..1 uri The namespace for the identifier value
.... value 0..1 string The value that is unique
.... period
..... id 0..0
..... end 0..1 dateTime End time with inclusive boundary, if not ongoing
.... assigner 0..0
... active 0..1 boolean Whether this practitioner role record is in active use
... period 0..1 Period The period during which the practitioner is authorized to perform in these role(s)
.... id 0..0
.... start 0..1 dateTime Starting time with inclusive boundary
.... end 0..1 dateTime End time with inclusive boundary, if not ongoing
... practitioner 0..1 Reference(PT_Practitioner) Practitioner that is able to provide the defined services for the organization
.... id 0..0
.... reference 0..1 string Literal reference, Relative, internal or absolute URL
.... type 0..0
.... identifier 0..0
.... display 0..0
... organization
.... id 0..0
.... reference 0..1 string Literal reference, Relative, internal or absolute URL
.... type 0..0
.... identifier 0..0
.... display 0..0
... Slices for code 0..* CodeableConcept Roles which this practitioner may perform
Slice: Unordered, Open by pattern:$this
Example System: {"text":"SNOMED"}
.... code:All Slices Content/Rules for all slices
..... id 0..0
..... coding 0..0
..... text 0..0
.... code:healthcareProfessionalRoles 0..* CodeableConcept Roles which this practitioner may perform
Binding: Healthcare Professional Roles - IPS (required): IPS Healthcare Professional Roles

..... id 0..0
..... coding
...... id 0..0
...... system 0..1 uri Identity of the terminology system
Example System: http://data.europa.eu/isco/isco-08
...... version 0..0
...... code 0..1 code Symbol in syntax defined by the system
...... display 0..1 string Representation defined by the system
...... userSelected 0..0
..... text 0..1 string Plain text representation of the concept
... specialty 0..* CodeableConcept Specific specialty of the practitioner
.... id 0..0
.... coding
..... id 0..0
..... system 0..1 uri Identity of the terminology system
Example System: SNOMED
..... version 0..0
..... code 0..1 code Symbol in syntax defined by the system
..... display 0..1 string Representation defined by the system
..... userSelected 0..0
.... text 0..0
... location 0..* Reference(PT_Location) The location(s) at which this practitioner provides care
.... id 0..0
.... reference 0..1 string Literal reference, Relative, internal or absolute URL
.... type 0..0
.... identifier 0..0
.... display 0..0
... healthcareService
.... id 0..0
.... reference 0..1 string Literal reference, Relative, internal or absolute URL
.... type 0..0
.... identifier 0..0
.... display 0..0
... telecom 0..* ContactPoint Contact details that are specific to the role/location/service
.... id 0..0
.... system 0..1 code phone | fax | email | pager | url | sms | other
.... value 0..1 string The actual contact point details
.... use 0..1 code ASN | WPN - purpose of this contact point
.... rank 0..0
.... period 0..0
... availableTime
.... id 0..0
... notAvailable
.... id 0..0
... availabilityExceptions 0..0
... endpoint 0..0

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
PractitionerRole.identifier.typeextensibleHl7VSIdentifierType
http://terminology.hl7.org/ValueSet/v2-0203
PractitionerRole.code:healthcareProfessionalRolesrequiredHealthcareProfessionalRolesUvIps (a valid code from urn:oid:2.16.840.1.113883.2.9.6.2.7)
http://hl7.org/fhir/uv/ips/ValueSet/healthcare-professional-roles-uv-ips

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. PractitionerRole 0..* PractitionerRole Roles/organizations the practitioner is associated with
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... lastUpdated Σ 0..1 instant When the resource version last changed
... extension 0..* Extension Additional content defined by implementations
... identifier Σ 0..* Identifier Business Identifiers that are specific to a role/location
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... type Σ 0..1 CodeableConcept Description of identifier
Binding: hl7VS-identifierType (extensible)
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ 0..* Coding Code defined by a terminology system
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ 0..1 uri Identity of the terminology system
...... code Σ 0..1 code Symbol in syntax defined by the system
...... display Σ 0..1 string Representation defined by the system
.... system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value Σ 0..1 string The value that is unique
Example General: 123456
.... period Σ 0..1 Period Time period when id is/was valid for use
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... start ΣC 0..1 dateTime Starting time with inclusive boundary
..... end ΣC 0..1 dateTime End time with inclusive boundary, if not ongoing
... active Σ 0..1 boolean Whether this practitioner role record is in active use
... period Σ 0..1 Period The period during which the practitioner is authorized to perform in these role(s)
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... start ΣC 0..1 dateTime Starting time with inclusive boundary
.... end ΣC 0..1 dateTime End time with inclusive boundary, if not ongoing
... practitioner Σ 0..1 Reference(PT_Practitioner) Practitioner that is able to provide the defined services for the organization
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
... organization Σ 0..1 Reference(Organization) Organization where the roles are available
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
... Slices for code Σ 0..* CodeableConcept Roles which this practitioner may perform
Slice: Unordered, Open by pattern:$this
Binding: PractitionerRole (example): The role a person plays representing an organization.



Example System: {"text":"SNOMED"}
.... code:All Slices Content/Rules for all slices
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... code:healthcareProfessionalRoles Σ 0..* CodeableConcept Roles which this practitioner may perform
Binding: Healthcare Professional Roles - IPS (required): IPS Healthcare Professional Roles


..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ 0..* Coding Code defined by a terminology system
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ 0..1 uri Identity of the terminology system
Example System: http://data.europa.eu/isco/isco-08
...... code Σ 0..1 code Symbol in syntax defined by the system
...... display Σ 0..1 string Representation defined by the system
..... text Σ 0..1 string Plain text representation of the concept
... specialty Σ 0..* CodeableConcept Specific specialty of the practitioner
Binding: PracticeSettingCodeValueSet (preferred): Specific specialty associated with the agency.


.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ 0..* Coding Code defined by a terminology system
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... system Σ 0..1 uri Identity of the terminology system
Example System: SNOMED
..... code Σ 0..1 code Symbol in syntax defined by the system
..... display Σ 0..1 string Representation defined by the system
... location Σ 0..* Reference(PT_Location) The location(s) at which this practitioner provides care
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
... healthcareService 0..* Reference(HealthcareService) The list of healthcare services that this worker provides for this role's Organization/Location(s)
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
... telecom Σ 0..* ContactPoint Contact details that are specific to the role/location/service
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... system ΣC 0..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

.... value Σ 0..1 string The actual contact point details
.... use ?!Σ 0..1 code ASN | WPN - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

... availableTime 0..* BackboneElement Times the Service Site is available
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... daysOfWeek 0..* code mon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required): The days of the week.


.... allDay 0..1 boolean Always available? e.g. 24 hour service
.... availableStartTime 0..1 time Opening time of day (ignored if allDay = true)
.... availableEndTime 0..1 time Closing time of day (ignored if allDay = true)
... notAvailable 0..* BackboneElement Not available during this time due to provided reason
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... description 1..1 string Reason presented to the user explaining why time not available
.... during 0..1 Period Service not available from this date

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
PractitionerRole.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
PractitionerRole.identifier.typeextensibleHl7VSIdentifierType
http://terminology.hl7.org/ValueSet/v2-0203
PractitionerRole.codeexamplePractitionerRole
http://hl7.org/fhir/ValueSet/practitioner-role
from the FHIR Standard
PractitionerRole.code:healthcareProfessionalRolesrequiredHealthcareProfessionalRolesUvIps (a valid code from urn:oid:2.16.840.1.113883.2.9.6.2.7)
http://hl7.org/fhir/uv/ips/ValueSet/healthcare-professional-roles-uv-ips
PractitionerRole.specialtypreferredPracticeSettingCodeValueSet
http://hl7.org/fhir/ValueSet/c80-practice-codes
from the FHIR Standard
PractitionerRole.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
PractitionerRole.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
PractitionerRole.availableTime.daysOfWeekrequiredDaysOfWeek
http://hl7.org/fhir/ValueSet/days-of-week|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorPractitionerRoleIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorPractitionerRoleIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorPractitionerRoleIf 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-5errorPractitionerRoleIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practicePractitionerRoleA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from PractitionerRole

Summary

Prohibited: 54 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of PractitionerRole.code

 

Other representations of profile: CSV, Excel, Schematron