Guia de Implementação do AnHealth
0.2.0 - CI Build

Guia de Implementação do AnHealth - Local Development build (v0.2.0). See the Directory of published versions

Resource Profile: PractitionerRole

Official URL: https://ancode.app/fhir/StructureDefinition/PractitionerRole Version: 0.2.0
Draft as of 2023-08-28 Computable Name: PractitionerRole

Usage:

  • This Resource Profile is not used by any profiles in this Implementation Guide

Formal Views of Profile Content

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

This structure is derived from PractitionerRole

NameFlagsCard.TypeDescription & Constraintsdoco
.. PractitionerRole 0..*PractitionerRoleRoles/organizations the practitioner is associated with
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... mainSpecialty 0..1CodeableConceptExtension
URL: https://ancode.app/fhir/StructureDefinition/CBOHealthcare
Binding: CBOHealthcare (required)
... active 1..1booleanWhether this practitioner role record is in active use
.... start 1..1dateTimeStarting time with inclusive boundary
... practitioner 1..1Reference(Practitioner)Practitioner that is able to provide the defined services for the organization
... organization 1..1Reference(Organization)Organization where the roles are available
... code 1..*CodeableConceptRoles which this practitioner may perform
Binding: PractitionerRoleMostUsed (required)
... specialty 0..*CodeableConceptSpecific specialty of the practitioner
Binding: CBOHealthcare (required)
... telecom 0..*ContactPointDetails of a Technology mediated contact point (phone, fax, email, etc.)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
PractitionerRole.coderequiredPractitionerRoleMostUsed
PractitionerRole.specialtyrequiredCBOHealthcare (a valid code from Classificação Brasileira de Ocupações - CBO)
NameFlagsCard.TypeDescription & Constraintsdoco
.. PractitionerRole 0..*PractitionerRoleRoles/organizations the practitioner is associated with
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... mainSpecialty 0..1CodeableConceptExtension
URL: https://ancode.app/fhir/StructureDefinition/CBOHealthcare
Binding: CBOHealthcare (required)
... active Σ1..1booleanWhether this practitioner role record is in active use
... period Σ1..1PeriodThe period during which the practitioner is authorized to perform in these role(s)
.... start ΣC1..1dateTimeStarting time with inclusive boundary
... practitioner Σ1..1Reference(Practitioner)Practitioner that is able to provide the defined services for the organization
... organization Σ1..1Reference(Organization)Organization where the roles are available
... code Σ1..*CodeableConceptRoles which this practitioner may perform
Binding: PractitionerRoleMostUsed (required)
... specialty Σ0..*CodeableConceptSpecific specialty of the practitioner
Binding: CBOHealthcare (required)
... telecom C0..*ContactPointDetails of a Technology mediated contact point (phone, fax, email, etc.)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
PractitionerRole.coderequiredPractitionerRoleMostUsed
PractitionerRole.specialtyrequiredCBOHealthcare (a valid code from Classificação Brasileira de Ocupações - CBO)

Constraints

IdGradePath(s)DetailsRequirements
cpt-2errorPractitionerRole.telecomA system is required if a value is provided.
: value.empty() or system.exists()
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.exists() and ('#'+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(uri) = '#').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()
NameFlagsCard.TypeDescription & Constraintsdoco
.. PractitionerRole 0..*PractitionerRoleRoles/organizations the practitioner is associated with
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... mainSpecialty 0..1CodeableConceptExtension
URL: https://ancode.app/fhir/StructureDefinition/CBOHealthcare
Binding: CBOHealthcare (required)
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierBusiness Identifiers that are specific to a role/location
... active Σ1..1booleanWhether this practitioner role record is in active use
... period Σ1..1PeriodThe period during which the practitioner is authorized to perform in these role(s)
.... id 0..1idUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... start ΣC1..1dateTimeStarting time with inclusive boundary
.... end ΣC0..1dateTimeEnd time with inclusive boundary, if not ongoing
... practitioner Σ1..1Reference(Practitioner)Practitioner that is able to provide the defined services for the organization
... organization Σ1..1Reference(Organization)Organization where the roles are available
... code Σ1..*CodeableConceptRoles which this practitioner may perform
Binding: PractitionerRoleMostUsed (required)
... specialty Σ0..*CodeableConceptSpecific specialty of the practitioner
Binding: CBOHealthcare (required)
... location Σ0..*Reference(Location)The location(s) at which this practitioner provides care
... healthcareService 0..*Reference(HealthcareService)The list of healthcare services that this worker provides for this role's Organization/Location(s)
... telecom C0..*ContactPointDetails of a Technology mediated contact point (phone, fax, email, etc.)
... availableTime 0..*BackboneElementTimes the Service Site is available
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... daysOfWeek 0..*codemon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required): The days of the week.


.... allDay 0..1booleanAlways available? e.g. 24 hour service
.... availableStartTime 0..1timeOpening time of day (ignored if allDay = true)
.... availableEndTime 0..1timeClosing time of day (ignored if allDay = true)
... notAvailable 0..*BackboneElementNot available during this time due to provided reason
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... description 1..1stringReason presented to the user explaining why time not available
.... during 0..1PeriodService not available from this date
... availabilityExceptions 0..1stringDescription of availability exceptions
... endpoint 0..*Reference(Endpoint)Technical endpoints providing access to services operated for the practitioner with this role

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
PractitionerRole.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
PractitionerRole.coderequiredPractitionerRoleMostUsed
PractitionerRole.specialtyrequiredCBOHealthcare (a valid code from Classificação Brasileira de Ocupações - CBO)
PractitionerRole.availableTime.daysOfWeekrequiredDaysOfWeek

Constraints

IdGradePath(s)DetailsRequirements
cpt-2errorPractitionerRole.telecomA system is required if a value is provided.
: value.empty() or system.exists()
dom-r4bwarningPractitionerRole.containedContaining new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems
: ($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic)
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

Mandatory: 6 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Differential View

This structure is derived from PractitionerRole

NameFlagsCard.TypeDescription & Constraintsdoco
.. PractitionerRole 0..*PractitionerRoleRoles/organizations the practitioner is associated with
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... mainSpecialty 0..1CodeableConceptExtension
URL: https://ancode.app/fhir/StructureDefinition/CBOHealthcare
Binding: CBOHealthcare (required)
... active 1..1booleanWhether this practitioner role record is in active use
.... start 1..1dateTimeStarting time with inclusive boundary
... practitioner 1..1Reference(Practitioner)Practitioner that is able to provide the defined services for the organization
... organization 1..1Reference(Organization)Organization where the roles are available
... code 1..*CodeableConceptRoles which this practitioner may perform
Binding: PractitionerRoleMostUsed (required)
... specialty 0..*CodeableConceptSpecific specialty of the practitioner
Binding: CBOHealthcare (required)
... telecom 0..*ContactPointDetails of a Technology mediated contact point (phone, fax, email, etc.)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
PractitionerRole.coderequiredPractitionerRoleMostUsed
PractitionerRole.specialtyrequiredCBOHealthcare (a valid code from Classificação Brasileira de Ocupações - CBO)

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. PractitionerRole 0..*PractitionerRoleRoles/organizations the practitioner is associated with
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... mainSpecialty 0..1CodeableConceptExtension
URL: https://ancode.app/fhir/StructureDefinition/CBOHealthcare
Binding: CBOHealthcare (required)
... active Σ1..1booleanWhether this practitioner role record is in active use
... period Σ1..1PeriodThe period during which the practitioner is authorized to perform in these role(s)
.... start ΣC1..1dateTimeStarting time with inclusive boundary
... practitioner Σ1..1Reference(Practitioner)Practitioner that is able to provide the defined services for the organization
... organization Σ1..1Reference(Organization)Organization where the roles are available
... code Σ1..*CodeableConceptRoles which this practitioner may perform
Binding: PractitionerRoleMostUsed (required)
... specialty Σ0..*CodeableConceptSpecific specialty of the practitioner
Binding: CBOHealthcare (required)
... telecom C0..*ContactPointDetails of a Technology mediated contact point (phone, fax, email, etc.)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
PractitionerRole.coderequiredPractitionerRoleMostUsed
PractitionerRole.specialtyrequiredCBOHealthcare (a valid code from Classificação Brasileira de Ocupações - CBO)

Constraints

IdGradePath(s)DetailsRequirements
cpt-2errorPractitionerRole.telecomA system is required if a value is provided.
: value.empty() or system.exists()
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.exists() and ('#'+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(uri) = '#').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()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. PractitionerRole 0..*PractitionerRoleRoles/organizations the practitioner is associated with
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... mainSpecialty 0..1CodeableConceptExtension
URL: https://ancode.app/fhir/StructureDefinition/CBOHealthcare
Binding: CBOHealthcare (required)
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierBusiness Identifiers that are specific to a role/location
... active Σ1..1booleanWhether this practitioner role record is in active use
... period Σ1..1PeriodThe period during which the practitioner is authorized to perform in these role(s)
.... id 0..1idUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... start ΣC1..1dateTimeStarting time with inclusive boundary
.... end ΣC0..1dateTimeEnd time with inclusive boundary, if not ongoing
... practitioner Σ1..1Reference(Practitioner)Practitioner that is able to provide the defined services for the organization
... organization Σ1..1Reference(Organization)Organization where the roles are available
... code Σ1..*CodeableConceptRoles which this practitioner may perform
Binding: PractitionerRoleMostUsed (required)
... specialty Σ0..*CodeableConceptSpecific specialty of the practitioner
Binding: CBOHealthcare (required)
... location Σ0..*Reference(Location)The location(s) at which this practitioner provides care
... healthcareService 0..*Reference(HealthcareService)The list of healthcare services that this worker provides for this role's Organization/Location(s)
... telecom C0..*ContactPointDetails of a Technology mediated contact point (phone, fax, email, etc.)
... availableTime 0..*BackboneElementTimes the Service Site is available
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... daysOfWeek 0..*codemon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required): The days of the week.


.... allDay 0..1booleanAlways available? e.g. 24 hour service
.... availableStartTime 0..1timeOpening time of day (ignored if allDay = true)
.... availableEndTime 0..1timeClosing time of day (ignored if allDay = true)
... notAvailable 0..*BackboneElementNot available during this time due to provided reason
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... description 1..1stringReason presented to the user explaining why time not available
.... during 0..1PeriodService not available from this date
... availabilityExceptions 0..1stringDescription of availability exceptions
... endpoint 0..*Reference(Endpoint)Technical endpoints providing access to services operated for the practitioner with this role

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
PractitionerRole.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
PractitionerRole.coderequiredPractitionerRoleMostUsed
PractitionerRole.specialtyrequiredCBOHealthcare (a valid code from Classificação Brasileira de Ocupações - CBO)
PractitionerRole.availableTime.daysOfWeekrequiredDaysOfWeek

Constraints

IdGradePath(s)DetailsRequirements
cpt-2errorPractitionerRole.telecomA system is required if a value is provided.
: value.empty() or system.exists()
dom-r4bwarningPractitionerRole.containedContaining new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems
: ($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic)
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

Mandatory: 6 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

 

Other representations of profile: CSV, Excel, Schematron