ITB - Online appointment booking service, published by Service Well AB. 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/servicewell/servicewell.fhir.wof-portal/ and changes regularly. See the Directory of published versions
| Active as of 2026-04-20 |
Definitions for the practitioner-role-portal resource profile.
Guidance on how to interpret the contents of this table can be foundhere
| 0. PractitionerRole | |||||||
| Definition | A specific set of Roles/Locations/specialties/services that a practitioner may perform at an organization for a period of time. | ||||||
| Short | Roles/organizations the practitioner is associated with | ||||||
| Control | 0..* | ||||||
| Is Modifier | false | ||||||
| Summary | false | ||||||
| Invariants | dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty()) 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 (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-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-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty()) dom-6: A resource should have narrative for robust management (text.`div`.exists()) | ||||||
| 2. PractitionerRole.id | |||||||
| Definition | Unique identifier for this PractitionerRolePortal resource instance. The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. | ||||||
| Short | Resource identifierLogical id of this artifact | ||||||
| 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. | ||||||
| Control | 10..1 | ||||||
| Type | idstring | ||||||
| Is Modifier | false | ||||||
| Summary | true | ||||||
| 4. PractitionerRole.meta | |||||||
| Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. | ||||||
| Short | Metadata about the resource | ||||||
| Control | 0..1 | ||||||
| Type | Meta | ||||||
| Is Modifier | false | ||||||
| Summary | true | ||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
| 6. PractitionerRole.meta.versionId | |||||||
| Definition | The technical resource version supplied by the server for change tracking of this specific PractitionerRolePortal instance. The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted. | ||||||
| Short | Server-managed resource versionVersion specific identifier | ||||||
| Comments | The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes. | ||||||
| Control | 0..1 | ||||||
| Type | id | ||||||
| Is Modifier | false | ||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
| Must Support | true | ||||||
| Obligations |
| ||||||
| Summary | true | ||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
| 8. PractitionerRole.meta.profile | |||||||
| Definition | Asserts the profile(s) this resource conforms to. A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url. | ||||||
| Short | Profile conformance declarationsProfiles this resource claims to conform to | ||||||
| Comments | It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set. | ||||||
| Control | 10..* | ||||||
| Type | canonical(StructureDefinition) | ||||||
| Is Modifier | false | ||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
| Must Support | true | ||||||
| Obligations |
| ||||||
| Summary | true | ||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
| 10. PractitionerRole.implicitRules | |||||||
| 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. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. | ||||||
| Short | A set of rules under which this content was created | ||||||
| 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. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. | ||||||
| Control | 0..01 | ||||||
| Type | uri | ||||||
| Is Modifier | true because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation | ||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
| Summary | true | ||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
| 12. PractitionerRole.extension:description | |||||||
| Slice Name | description | ||||||
| Definition | Description of the practitioner role. | ||||||
| Short | PractitionerRole Description | ||||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||||
| Type | Extension(PractitionerRole Description) (Extension Type: string) | ||||||
| Is Modifier | false | ||||||
| Summary | false | ||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists())ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) | ||||||
| 14. PractitionerRole.extension:description.extension | |||||||
| Definition | An Extension May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||
| Short | ExtensionAdditional content defined by implementations | ||||||
| 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. | ||||||
| Control | 0..0* | ||||||
| Type | Extension | ||||||
| Is Modifier | false | ||||||
| Summary | false | ||||||
| Alternate Names | extensions, user content | ||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) | ||||||
| Slicing | This element introduces a set of slices on PractitionerRole.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||||
| 16. PractitionerRole.extension:description.url | |||||||
| Definition | Source of the definition for the extension code - a logical name or a URL. | ||||||
| Short | identifies the meaning of the extension | ||||||
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||||||
| Control | 1..1 | ||||||
| Type | uri | ||||||
| Is Modifier | false | ||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||
| Summary | false | ||||||
| Fixed Value | https://canonical.fhir.link/servicewell/wof-portal/StructureDefinition/ext-practitionerrole-description | ||||||
| 18. PractitionerRole.extension:description.value[x] | |||||||
| Definition | A human-readable description of the practitioner role, providing additional context about the services or specialties offered in this role. Displayed to patients in booking and offer flows. Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | ||||||
| Short | Description textValue of extension | ||||||
| Control | 0..1 | ||||||
| Type | string, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time | ||||||
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||||
| Is Modifier | false | ||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
| Must Support | true | ||||||
| Summary | false | ||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
| 20. PractitionerRole.extension:binaryReference | |||||||
| Slice Name | binaryReference | ||||||
| Definition | Reference to a contained Binary resource. | ||||||
| Short | Binary Reference | ||||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||||
| Type | Extension(Binary Reference) (Extension Type: Reference(Binary)) | ||||||
| Is Modifier | false | ||||||
| Summary | false | ||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists())ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) | ||||||
| 22. PractitionerRole.extension:binaryReference.extension | |||||||
| Definition | An Extension May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||
| Short | ExtensionAdditional content defined by implementations | ||||||
| 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. | ||||||
| Control | 0..0* | ||||||
| Type | Extension | ||||||
| Is Modifier | false | ||||||
| Summary | false | ||||||
| Alternate Names | extensions, user content | ||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) | ||||||
| Slicing | This element introduces a set of slices on PractitionerRole.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||||
| 24. PractitionerRole.extension:binaryReference.url | |||||||
| Definition | Source of the definition for the extension code - a logical name or a URL. | ||||||
| Short | identifies the meaning of the extension | ||||||
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||||||
| Control | 1..1 | ||||||
| Type | uri | ||||||
| Is Modifier | false | ||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||
| Summary | false | ||||||
| Fixed Value | https://canonical.fhir.link/servicewell/wof-portal/StructureDefinition/ext-binary-reference | ||||||
| 26. PractitionerRole.extension:binaryReference.value[x] | |||||||
| Definition | A reference to a Binary resource contained inline in this PractitionerRole, typically carrying image data such as a practitioner photo. Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | ||||||
| Short | Reference to a contained BinaryValue of extension | ||||||
| Control | 0..1 | ||||||
| Type | Reference(Binary), date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time | ||||||
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||||
| Is Modifier | false | ||||||
| Must Support | true | ||||||
| Summary | false | ||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
| 28. PractitionerRole.modifierExtension | |||||||
| Definition | An Extension 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 and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||||
| Short | ExtensionExtensions that cannot be ignored | ||||||
| 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. | ||||||
| Control | 0..0* | ||||||
| Type | Extension | ||||||
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them | ||||||
| Summary | false | ||||||
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||||
| Alternate Names | extensions, user content | ||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) | ||||||
| 30. PractitionerRole.identifier | |||||||
| Definition | Business Identifiers that are specific to a role/location. | ||||||
| Short | Business Identifiers that are specific to a role/location | ||||||
| Note | This is a business identifier, not a resource identifier (see discussion) | ||||||
| Control | 0..0* | ||||||
| Type | Identifier | ||||||
| Is Modifier | false | ||||||
| Summary | true | ||||||
| Requirements | Often, specific identities are assigned for the agent. | ||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
| 32. PractitionerRole.active | |||||||
| Definition | Indicates whether this PractitionerRolePortal is currently active and available for booking, offers, and service-specific configuration. Whether this practitioner role record is in active use. | ||||||
| Short | Whether this practitioner role is activeWhether this practitioner role record is in active use | ||||||
| Comments | If this value is false, you may refer to the period to see when the role was in active use. If there is no period specified, no inference can be made about when it was active. | ||||||
| Control | 10..1 | ||||||
| Type | boolean | ||||||
| Is Modifier | false | ||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
| Summary | true | ||||||
| Requirements | Need to be able to mark a practitioner role record as not to be used because it was created in error, or otherwise no longer in active use. | ||||||
| Meaning if Missing | This resource is generally assumed to be active if no value is provided for the active element | ||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
| 34. PractitionerRole.period | |||||||
| Definition | The period during which the person is authorized to act as a practitioner in these role(s) for the organization. | ||||||
| Short | The period during which the practitioner is authorized to perform in these role(s) | ||||||
| Control | 0..01 | ||||||
| Type | Period | ||||||
| Is Modifier | false | ||||||
| Summary | true | ||||||
| Requirements | Even after the agencies is revoked, the fact that it existed must still be recorded. | ||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
| 36. PractitionerRole.practitioner | |||||||
| Definition | Identifier-based binding to the Practitioner logical model performing services in this role. Practitioner is not exposed as a standalone API resource in WOF Portal. Identifier systems are governed under the WofPortalIdentifierSystemRoot namespace. Practitioner that is able to provide the defined services for the organization. | ||||||
| Short | The individual practitionerPractitioner that is able to provide the defined services for the organization | ||||||
| Control | 10..1 | ||||||
| Type | Reference(Practitioner) | ||||||
| Is Modifier | false | ||||||
| Summary | true | ||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
| 38. PractitionerRole.practitioner.reference | |||||||
| Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. | ||||||
| Short | Literal reference, Relative, internal or absolute URL | ||||||
| Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. | ||||||
| Control | 0..01 This element is affected by the following invariants: ref-1 | ||||||
| Type | string | ||||||
| Is Modifier | false | ||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
| Summary | true | ||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
| 40. PractitionerRole.practitioner.identifier | |||||||
| Definition | Identifier-based reference to the Practitioner concept in the source system. See EndpointIdentifierSystemForPractitioner for expected identifier.system values. An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. | ||||||
| Short | Identifier for the practitionerLogical reference, when literal reference is not known | ||||||
| Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). | ||||||
| Note | This is a business identifier, not a resource identifier (see discussion) | ||||||
| Control | 10..1 | ||||||
| Type | Identifier | ||||||
| Is Modifier | false | ||||||
| Summary | true | ||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
| 42. PractitionerRole.practitioner.display | |||||||
| Definition | The human-readable name of the practitioner, used for display purposes. Plain text narrative that identifies the resource in addition to the resource reference. | ||||||
| Short | Display name of the practitionerText alternative for the resource | ||||||
| Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. | ||||||
| Control | 10..1 | ||||||
| Type | string | ||||||
| Is Modifier | false | ||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
| Summary | true | ||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
| 44. PractitionerRole.organization | |||||||
| Definition | Identifier-based binding to the BillingOrganization logical model that is financially responsible for services performed in this role. BillingOrganization is not exposed as a standalone API resource in WOF Portal. Identifier systems are governed under the WofPortalIdentifierSystemRoot namespace. The organization where the Practitioner performs the roles associated. | ||||||
| Short | Binding to the billing organizationOrganization where the roles are available | ||||||
| Control | 10..1 | ||||||
| Type | Reference(Organization) | ||||||
| Is Modifier | false | ||||||
| Summary | true | ||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
| 46. PractitionerRole.organization.reference | |||||||
| Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. | ||||||
| Short | Literal reference, Relative, internal or absolute URL | ||||||
| Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. | ||||||
| Control | 0..01 This element is affected by the following invariants: ref-1 | ||||||
| Type | string | ||||||
| Is Modifier | false | ||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
| Summary | true | ||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
| 48. PractitionerRole.organization.type | |||||||
| Definition | The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). | ||||||
| Short | Type the reference refers to (e.g. "Patient") | ||||||
| Comments | This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. | ||||||
| Control | 0..01 | ||||||
| Binding | Unless not suitable, these codes SHALL be taken from ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types|4.0.1 (extensible to http://hl7.org/fhir/ValueSet/resource-types|4.0.1)Aa resource (or, for logical models, the URI of the logical model). | ||||||
| Type | uri | ||||||
| Is Modifier | false | ||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
| Summary | true | ||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
| 50. PractitionerRole.organization.identifier | |||||||
| Definition | Identifier-based reference to the BillingOrganization concept in the source system. See EndpointIdentifierSystemForBillingOrganization for expected identifier.system values. An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. | ||||||
| Short | Identifier for the billing organizationLogical reference, when literal reference is not known | ||||||
| Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). | ||||||
| Note | This is a business identifier, not a resource identifier (see discussion) | ||||||
| Control | 10..1 | ||||||
| Type | Identifier | ||||||
| Is Modifier | false | ||||||
| Summary | true | ||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
| 52. PractitionerRole.code | |||||||
| Definition | The role(s) the practitioner performs in this context, e.g., the type of clinical or administrative function. Roles which this practitioner is authorized to perform for the organization. | ||||||
| Short | Role codeRoles which this practitioner may perform | ||||||
| Comments | A person may have more than one role. | ||||||
| Control | 10..* | ||||||
| Binding | For example codes, see PractitionerRolehttp://hl7.org/fhir/ValueSet/practitioner-role|4.0.1 (example to http://hl7.org/fhir/ValueSet/practitioner-role|4.0.1)The role a person plays representing an organization. | ||||||
| Type | CodeableConcept | ||||||
| Is Modifier | false | ||||||
| Summary | true | ||||||
| Requirements | Need to know what authority the practitioner has - what can they do? | ||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
| 54. PractitionerRole.location | |||||||
| Definition | The location(s) at which this practitioner provides care. | ||||||
| Short | The location(s) at which this practitioner provides care | ||||||
| Control | 0..0* | ||||||
| Type | Reference(Location) | ||||||
| Is Modifier | false | ||||||
| Summary | true | ||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
| 56. PractitionerRole.healthcareService | |||||||
| Definition | Reference to the HealthcareServicePortal where this practitioner performs services in this role. A practitioner may work at multiple HealthcareServicePortals but each practitioner-healthcareservice relation makes the practitionerrole unique. The list of healthcare services that this worker provides for this role's Organization/Location(s). | ||||||
| Short | Service location where this role is performedThe list of healthcare services that this worker provides for this role's Organization/Location(s) | ||||||
| Control | 10..1* | ||||||
| Type | Reference(HealthcareService) | ||||||
| Is Modifier | false | ||||||
| Summary | false | ||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
| 58. PractitionerRole.telecom | |||||||
| Definition | Contact details that are specific to the role/location/service. | ||||||
| Short | Contact details that are specific to the role/location/service | ||||||
| Control | 0..0* | ||||||
| Type | ContactPoint | ||||||
| Is Modifier | false | ||||||
| Summary | true | ||||||
| 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. | ||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
| 60. PractitionerRole.availableTime | |||||||
| Definition | A collection of times the practitioner is available or performing this role at the location and/or healthcareservice. | ||||||
| Short | Times the Service Site is available | ||||||
| Comments | More detailed availability information may be provided in associated Schedule/Slot resources. | ||||||
| Control | 0..0* | ||||||
| Type | BackboneElement | ||||||
| Is Modifier | false | ||||||
| Summary | false | ||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
| 63. PractitionerRole.notAvailable | |||||||
| Definition | The practitioner is not available or performing this role during this period of time due to the provided reason. | ||||||
| Short | Not available during this time due to provided reason | ||||||
| Control | 0..0* | ||||||
| Type | BackboneElement | ||||||
| Is Modifier | false | ||||||
| Summary | false | ||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
| 67. PractitionerRole.availabilityExceptions | |||||||
| 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. | ||||||
| Short | Description of availability exceptions | ||||||
| Control | 0..01 | ||||||
| Type | string | ||||||
| Is Modifier | false | ||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
| Summary | false | ||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
| 69. PractitionerRole.endpoint | |||||||
| Definition | Technical endpoints providing access to services operated for the practitioner with this role. | ||||||
| Short | Technical endpoints providing access to services operated for the practitioner with this role | ||||||
| Control | 0..0* | ||||||
| Type | Reference(Endpoint) | ||||||
| Is Modifier | false | ||||||
| Summary | false | ||||||
| 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. | ||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
Guidance on how to interpret the contents of this table can be foundhere
| 0. PractitionerRole | |
| 2. PractitionerRole.meta | |
| 4. PractitionerRole.meta.versionId | |
| Definition | The technical resource version supplied by the server for change tracking of this specific PractitionerRolePortal instance. |
| 6. PractitionerRole.meta.profile | |
| Definition | Asserts the profile(s) this resource conforms to. |
| Short | Profile conformance declarations |
| 8. PractitionerRole.extension:description | |
| Slice Name | description |
| 10. PractitionerRole.extension:description.value[x] | |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Must Support | true |
| 12. PractitionerRole.extension:binaryReference | |
| Slice Name | binaryReference |
| 14. PractitionerRole.extension:binaryReference.value[x] | |
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] |
| Must Support | true |
| 16. PractitionerRole.active | |
| Definition | Indicates whether this PractitionerRolePortal is currently active and available for booking, offers, and service-specific configuration. |
| 18. PractitionerRole.period | |
| Control | 0..0 |
| 20. PractitionerRole.practitioner | |
| 22. PractitionerRole.practitioner.reference | |
| Control | 0..0 |
| 24. PractitionerRole.practitioner.identifier | |
| Definition | Identifier-based reference to the Practitioner concept in the source system. See EndpointIdentifierSystemForPractitioner for expected identifier.system values. |
| Note | This is a business identifier, not a resource identifier (see discussion) |
| Control | 1..? |
| 26. PractitionerRole.organization | |
| Control | 1..? |
| 28. PractitionerRole.organization.reference | |
| Control | 0..0 |
| 30. PractitionerRole.healthcareService | |
| Control | 1..? |
| 32. PractitionerRole.endpoint | |
| Control | 0..0 |
Guidance on how to interpret the contents of this table can be foundhere
| 0. PractitionerRole | |||||||
| Definition | A specific set of Roles/Locations/specialties/services that a practitioner may perform at an organization for a period of time. | ||||||
| Short | Roles/organizations the practitioner is associated with | ||||||
| Control | 0..* | ||||||
| Is Modifier | false | ||||||
| Summary | false | ||||||
| Invariants | dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())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 ( 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-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-5: If a resource is contained in another resource, it SHALL NOT have a security label ( contained.meta.security.empty())dom-6: A resource should have narrative for robust management ( text.`div`.exists()) | ||||||
| 2. PractitionerRole.id | |||||||
| Definition | Unique identifier for this PractitionerRolePortal resource instance. | ||||||
| Short | Resource identifier | ||||||
| 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. | ||||||
| Control | 1..1 | ||||||
| Type | id | ||||||
| Is Modifier | false | ||||||
| Summary | true | ||||||
| 4. PractitionerRole.meta | |||||||
| Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. | ||||||
| Short | Metadata about the resource | ||||||
| Control | 0..1 | ||||||
| Type | Meta | ||||||
| Is Modifier | false | ||||||
| Summary | true | ||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
| 6. PractitionerRole.meta.id | |||||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||||
| Short | Unique id for inter-element referencing | ||||||
| Control | 0..1 | ||||||
| Type | string | ||||||
| Is Modifier | false | ||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||
| Summary | false | ||||||
| 8. PractitionerRole.meta.extension | |||||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||
| Short | Additional content defined by implementations | ||||||
| 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. | ||||||
| Control | 0..* | ||||||
| Type | Extension | ||||||
| Is Modifier | false | ||||||
| Summary | false | ||||||
| Alternate Names | extensions, user content | ||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||||
| Slicing | This element introduces a set of slices on PractitionerRole.meta.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||||
| 10. PractitionerRole.meta.versionId | |||||||
| Definition | The technical resource version supplied by the server for change tracking of this specific PractitionerRolePortal instance. | ||||||
| Short | Server-managed resource version | ||||||
| Comments | The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes. | ||||||
| Control | 0..1 | ||||||
| Type | id | ||||||
| Is Modifier | false | ||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
| Must Support | true | ||||||
| Obligations |
| ||||||
| Summary | true | ||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
| 12. PractitionerRole.meta.lastUpdated | |||||||
| Definition | When the resource last changed - e.g. when the version changed. | ||||||
| Short | When the resource version last changed | ||||||
| Comments | This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a read interaction. | ||||||
| Control | 0..1 | ||||||
| Type | instant | ||||||
| Is Modifier | false | ||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
| Summary | true | ||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
| 14. PractitionerRole.meta.source | |||||||
| Definition | A uri that identifies the source system of the resource. This provides a minimal amount of Provenance information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc. | ||||||
| Short | Identifies where the resource comes from | ||||||
| Comments | In the provenance resource, this corresponds to Provenance.entity.what[x]. The exact use of the source (and the implied Provenance.entity.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used. This element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL. | ||||||
| Control | 0..1 | ||||||
| Type | uri | ||||||
| Is Modifier | false | ||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
| Summary | true | ||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
| 16. PractitionerRole.meta.profile | |||||||
| Definition | Asserts the profile(s) this resource conforms to. | ||||||
| Short | Profile conformance declarations | ||||||
| Comments | It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set. | ||||||
| Control | 1..* | ||||||
| Type | canonical(StructureDefinition) | ||||||
| Is Modifier | false | ||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
| Must Support | true | ||||||
| Obligations |
| ||||||
| Summary | true | ||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
| 18. PractitionerRole.meta.security | |||||||
| Definition | Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure. | ||||||
| Short | Security Labels applied to this resource | ||||||
| Comments | The security labels can be updated without changing the stated version of the resource. The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored. | ||||||
| Control | 0..* | ||||||
| Binding | Unless not suitable, these codes SHALL be taken from All Security Labels (extensible to http://hl7.org/fhir/ValueSet/security-labels|4.0.1)Security Labels from the Healthcare Privacy and Security Classification System. | ||||||
| Type | Coding | ||||||
| Is Modifier | false | ||||||
| Summary | true | ||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
| 20. PractitionerRole.meta.tag | |||||||
| Definition | Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource. | ||||||
| Short | Tags applied to this resource | ||||||
| Comments | The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored. | ||||||
| Control | 0..* | ||||||
| Binding | For example codes, see CommonTags (example to http://hl7.org/fhir/ValueSet/common-tags|4.0.1)Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||||
| Type | Coding | ||||||
| Is Modifier | false | ||||||
| Summary | true | ||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
| 22. PractitionerRole.implicitRules | |||||||
| 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. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. | ||||||
| Short | A set of rules under which this content was created | ||||||
| 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. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. | ||||||
| Control | 0..0 | ||||||
| Type | uri | ||||||
| Is Modifier | true because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation | ||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
| Summary | true | ||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
| 24. PractitionerRole.language | |||||||
| Definition | The base language in which the resource is written. | ||||||
| Short | Language of the resource content | ||||||
| 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). | ||||||
| Control | 0..1 | ||||||
| Binding | The codes SHOULD be taken from CommonLanguages (preferred to http://hl7.org/fhir/ValueSet/languages|4.0.1)A human language.
| ||||||
| Type | code | ||||||
| Is Modifier | false | ||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
| Summary | false | ||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
| 26. PractitionerRole.text | |||||||
| Definition | A human-readable narrative that contains a summary of the resource and can 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. | ||||||
| Short | Text summary of the resource, for human interpretation | ||||||
| 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 information is added later. | ||||||
| Control | 0..1 | ||||||
| Type | Narrative | ||||||
| Is Modifier | false | ||||||
| Summary | false | ||||||
| Alternate Names | narrative, html, xhtml, display | ||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
| 28. PractitionerRole.contained | |||||||
| Definition | Inline Binary resources, typically used to carry image data (e.g., practitioner photo) referenced via the binaryReference extension. | ||||||
| Short | Contained Binary resources | ||||||
| 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. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels. | ||||||
| Control | 0..* | ||||||
| Type | Resource | ||||||
| Is Modifier | false | ||||||
| Summary | false | ||||||
| Alternate Names | inline resources, anonymous resources, contained resources | ||||||
| 30. PractitionerRole.extension | |||||||
| Definition | An Extension | ||||||
| Short | Extension | ||||||
| Control | 0..* | ||||||
| Type | Extension | ||||||
| Is Modifier | false | ||||||
| Summary | false | ||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||||
| Slicing | This element introduces a set of slices on PractitionerRole.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||||
| 32. PractitionerRole.extension:description | |||||||
| Slice Name | description | ||||||
| Definition | Description of the practitioner role. | ||||||
| Short | PractitionerRole Description | ||||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||||
| Type | Extension(PractitionerRole Description) (Extension Type: string) | ||||||
| Is Modifier | false | ||||||
| Summary | false | ||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||||
| 34. PractitionerRole.extension:description.id | |||||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||||
| Short | Unique id for inter-element referencing | ||||||
| Control | 0..1 | ||||||
| Type | string | ||||||
| Is Modifier | false | ||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||
| Summary | false | ||||||
| 36. PractitionerRole.extension:description.extension | |||||||
| Definition | An Extension | ||||||
| Short | Extension | ||||||
| Control | 0..0 | ||||||
| Type | Extension | ||||||
| Is Modifier | false | ||||||
| Summary | false | ||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||||
| Slicing | This element introduces a set of slices on PractitionerRole.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||||
| 38. PractitionerRole.extension:description.url | |||||||
| Definition | Source of the definition for the extension code - a logical name or a URL. | ||||||
| Short | identifies the meaning of the extension | ||||||
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||||||
| Control | 1..1 | ||||||
| Type | uri | ||||||
| Is Modifier | false | ||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||
| Summary | false | ||||||
| Fixed Value | https://canonical.fhir.link/servicewell/wof-portal/StructureDefinition/ext-practitionerrole-description | ||||||
| 40. PractitionerRole.extension:description.value[x] | |||||||
| Definition | A human-readable description of the practitioner role, providing additional context about the services or specialties offered in this role. Displayed to patients in booking and offer flows. | ||||||
| Short | Description text | ||||||
| Control | 0..1 | ||||||
| Type | string | ||||||
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||||
| Is Modifier | false | ||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
| Must Support | true | ||||||
| Summary | false | ||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
| 42. PractitionerRole.extension:binaryReference | |||||||
| Slice Name | binaryReference | ||||||
| Definition | Reference to a contained Binary resource. | ||||||
| Short | Binary Reference | ||||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||||
| Type | Extension(Binary Reference) (Extension Type: Reference(Binary)) | ||||||
| Is Modifier | false | ||||||
| Summary | false | ||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||||
| 44. PractitionerRole.extension:binaryReference.id | |||||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||||
| Short | Unique id for inter-element referencing | ||||||
| Control | 0..1 | ||||||
| Type | string | ||||||
| Is Modifier | false | ||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||
| Summary | false | ||||||
| 46. PractitionerRole.extension:binaryReference.extension | |||||||
| Definition | An Extension | ||||||
| Short | Extension | ||||||
| Control | 0..0 | ||||||
| Type | Extension | ||||||
| Is Modifier | false | ||||||
| Summary | false | ||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||||
| Slicing | This element introduces a set of slices on PractitionerRole.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||||
| 48. PractitionerRole.extension:binaryReference.url | |||||||
| Definition | Source of the definition for the extension code - a logical name or a URL. | ||||||
| Short | identifies the meaning of the extension | ||||||
| Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||||||
| Control | 1..1 | ||||||
| Type | uri | ||||||
| Is Modifier | false | ||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||
| Summary | false | ||||||
| Fixed Value | https://canonical.fhir.link/servicewell/wof-portal/StructureDefinition/ext-binary-reference | ||||||
| 50. PractitionerRole.extension:binaryReference.value[x] | |||||||
| Definition | A reference to a Binary resource contained inline in this PractitionerRole, typically carrying image data such as a practitioner photo. | ||||||
| Short | Reference to a contained Binary | ||||||
| Control | 0..1 | ||||||
| Type | Reference(Binary) | ||||||
| [x] Note | SeeChoice of Data Typesfor further information about how to use [x] | ||||||
| Is Modifier | false | ||||||
| Must Support | true | ||||||
| Summary | false | ||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
| 52. PractitionerRole.modifierExtension | |||||||
| Definition | An Extension | ||||||
| Short | Extension | ||||||
| Control | 0..0 | ||||||
| Type | Extension | ||||||
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them | ||||||
| Summary | false | ||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||||
| 54. PractitionerRole.identifier | |||||||
| Definition | Business Identifiers that are specific to a role/location. | ||||||
| Short | Business Identifiers that are specific to a role/location | ||||||
| Note | This is a business identifier, not a resource identifier (see discussion) | ||||||
| Control | 0..0 | ||||||
| Type | Identifier | ||||||
| Is Modifier | false | ||||||
| Summary | true | ||||||
| Requirements | Often, specific identities are assigned for the agent. | ||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
| 56. PractitionerRole.active | |||||||
| Definition | Indicates whether this PractitionerRolePortal is currently active and available for booking, offers, and service-specific configuration. | ||||||
| Short | Whether this practitioner role is active | ||||||
| Comments | If this value is false, you may refer to the period to see when the role was in active use. If there is no period specified, no inference can be made about when it was active. | ||||||
| Control | 1..1 | ||||||
| Type | boolean | ||||||
| Is Modifier | false | ||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
| Summary | true | ||||||
| Requirements | Need to be able to mark a practitioner role record as not to be used because it was created in error, or otherwise no longer in active use. | ||||||
| Meaning if Missing | This resource is generally assumed to be active if no value is provided for the active element | ||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
| 58. PractitionerRole.period | |||||||
| Definition | The period during which the person is authorized to act as a practitioner in these role(s) for the organization. | ||||||
| Short | The period during which the practitioner is authorized to perform in these role(s) | ||||||
| Control | 0..0 | ||||||
| Type | Period | ||||||
| Is Modifier | false | ||||||
| Summary | true | ||||||
| Requirements | Even after the agencies is revoked, the fact that it existed must still be recorded. | ||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
| 60. PractitionerRole.practitioner | |||||||
| Definition | Identifier-based binding to the Practitioner logical model performing services in this role. Practitioner is not exposed as a standalone API resource in WOF Portal. Identifier systems are governed under the WofPortalIdentifierSystemRoot namespace. | ||||||
| Short | The individual practitioner | ||||||
| Control | 1..1 | ||||||
| Type | Reference(Practitioner) | ||||||
| Is Modifier | false | ||||||
| Summary | true | ||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
| 62. PractitionerRole.practitioner.id | |||||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||||
| Short | Unique id for inter-element referencing | ||||||
| Control | 0..1 | ||||||
| Type | string | ||||||
| Is Modifier | false | ||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||
| Summary | false | ||||||
| 64. PractitionerRole.practitioner.extension | |||||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||
| Short | Additional content defined by implementations | ||||||
| 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. | ||||||
| Control | 0..* | ||||||
| Type | Extension | ||||||
| Is Modifier | false | ||||||
| Summary | false | ||||||
| Alternate Names | extensions, user content | ||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||||
| Slicing | This element introduces a set of slices on PractitionerRole.practitioner.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||||
| 66. PractitionerRole.practitioner.reference | |||||||
| Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. | ||||||
| Short | Literal reference, Relative, internal or absolute URL | ||||||
| Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. | ||||||
| Control | 0..0 This element is affected by the following invariants: ref-1 | ||||||
| Type | string | ||||||
| Is Modifier | false | ||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
| Summary | true | ||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
| 68. PractitionerRole.practitioner.type | |||||||
| Definition | The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). | ||||||
| Short | Type the reference refers to (e.g. "Patient") | ||||||
| Comments | This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. | ||||||
| Control | 0..1 | ||||||
| Binding | Unless not suitable, these codes SHALL be taken from ResourceType (extensible to http://hl7.org/fhir/ValueSet/resource-types|4.0.1)Aa resource (or, for logical models, the URI of the logical model). | ||||||
| Type | uri | ||||||
| Is Modifier | false | ||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
| Summary | true | ||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
| 70. PractitionerRole.practitioner.identifier | |||||||
| Definition | Identifier-based reference to the Practitioner concept in the source system. See EndpointIdentifierSystemForPractitioner for expected identifier.system values. | ||||||
| Short | Identifier for the practitioner | ||||||
| Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). | ||||||
| Note | This is a business identifier, not a resource identifier (see discussion) | ||||||
| Control | 1..1 | ||||||
| Type | Identifier | ||||||
| Is Modifier | false | ||||||
| Summary | true | ||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
| 72. PractitionerRole.practitioner.display | |||||||
| Definition | The human-readable name of the practitioner, used for display purposes. | ||||||
| Short | Display name of the practitioner | ||||||
| Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. | ||||||
| Control | 1..1 | ||||||
| Type | string | ||||||
| Is Modifier | false | ||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
| Summary | true | ||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
| 74. PractitionerRole.organization | |||||||
| Definition | Identifier-based binding to the BillingOrganization logical model that is financially responsible for services performed in this role. BillingOrganization is not exposed as a standalone API resource in WOF Portal. Identifier systems are governed under the WofPortalIdentifierSystemRoot namespace. | ||||||
| Short | Binding to the billing organization | ||||||
| Control | 1..1 | ||||||
| Type | Reference(Organization) | ||||||
| Is Modifier | false | ||||||
| Summary | true | ||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
| 76. PractitionerRole.organization.id | |||||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||||
| Short | Unique id for inter-element referencing | ||||||
| Control | 0..1 | ||||||
| Type | string | ||||||
| Is Modifier | false | ||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||
| Summary | false | ||||||
| 78. PractitionerRole.organization.extension | |||||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||
| Short | Additional content defined by implementations | ||||||
| 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. | ||||||
| Control | 0..* | ||||||
| Type | Extension | ||||||
| Is Modifier | false | ||||||
| Summary | false | ||||||
| Alternate Names | extensions, user content | ||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||||
| Slicing | This element introduces a set of slices on PractitionerRole.organization.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||||
| 80. PractitionerRole.organization.reference | |||||||
| Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. | ||||||
| Short | Literal reference, Relative, internal or absolute URL | ||||||
| Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. | ||||||
| Control | 0..0 This element is affected by the following invariants: ref-1 | ||||||
| Type | string | ||||||
| Is Modifier | false | ||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
| Summary | true | ||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
| 82. PractitionerRole.organization.type | |||||||
| Definition | The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). | ||||||
| Short | Type the reference refers to (e.g. "Patient") | ||||||
| Comments | This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. | ||||||
| Control | 0..0 | ||||||
| Binding | Unless not suitable, these codes SHALL be taken from ResourceType (extensible to http://hl7.org/fhir/ValueSet/resource-types|4.0.1)Aa resource (or, for logical models, the URI of the logical model). | ||||||
| Type | uri | ||||||
| Is Modifier | false | ||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
| Summary | true | ||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
| 84. PractitionerRole.organization.identifier | |||||||
| Definition | Identifier-based reference to the BillingOrganization concept in the source system. See EndpointIdentifierSystemForBillingOrganization for expected identifier.system values. | ||||||
| Short | Identifier for the billing organization | ||||||
| Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). | ||||||
| Note | This is a business identifier, not a resource identifier (see discussion) | ||||||
| Control | 1..1 | ||||||
| Type | Identifier | ||||||
| Is Modifier | false | ||||||
| Summary | true | ||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
| 86. PractitionerRole.organization.display | |||||||
| Definition | The human-readable name of the billing organization, used for display purposes. | ||||||
| Short | Display name of the billing organization | ||||||
| Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. | ||||||
| Control | 0..1 | ||||||
| Type | string | ||||||
| Is Modifier | false | ||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
| Summary | true | ||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
| 88. PractitionerRole.code | |||||||
| Definition | The role(s) the practitioner performs in this context, e.g., the type of clinical or administrative function. | ||||||
| Short | Role code | ||||||
| Comments | A person may have more than one role. | ||||||
| Control | 1..* | ||||||
| Binding | For example codes, see PractitionerRole (example to http://hl7.org/fhir/ValueSet/practitioner-role|4.0.1)The role a person plays representing an organization. | ||||||
| Type | CodeableConcept | ||||||
| Is Modifier | false | ||||||
| Summary | true | ||||||
| Requirements | Need to know what authority the practitioner has - what can they do? | ||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
| 90. PractitionerRole.specialty | |||||||
| Definition | The clinical specialty of the practitioner in this role, used to categorize the type of care delivered. | ||||||
| Short | Clinical specialty | ||||||
| Control | 0..* | ||||||
| Binding | The codes SHOULD be taken from PracticeSettingCodeValueSet (preferred to http://hl7.org/fhir/ValueSet/c80-practice-codes|4.0.1)Specific specialty associated with the agency. | ||||||
| Type | CodeableConcept | ||||||
| Is Modifier | false | ||||||
| Summary | true | ||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
| 92. PractitionerRole.location | |||||||
| Definition | The location(s) at which this practitioner provides care. | ||||||
| Short | The location(s) at which this practitioner provides care | ||||||
| Control | 0..0 | ||||||
| Type | Reference(Location) | ||||||
| Is Modifier | false | ||||||
| Summary | true | ||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
| 94. PractitionerRole.healthcareService | |||||||
| Definition | Reference to the HealthcareServicePortal where this practitioner performs services in this role. A practitioner may work at multiple HealthcareServicePortals but each practitioner-healthcareservice relation makes the practitionerrole unique. | ||||||
| Short | Service location where this role is performed | ||||||
| Control | 1..1 | ||||||
| Type | Reference(HealthcareService) | ||||||
| Is Modifier | false | ||||||
| Summary | false | ||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
| 96. PractitionerRole.healthcareService.id | |||||||
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||||
| Short | Unique id for inter-element referencing | ||||||
| Control | 0..1 | ||||||
| Type | string | ||||||
| Is Modifier | false | ||||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||||
| Summary | false | ||||||
| 98. PractitionerRole.healthcareService.extension | |||||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||
| Short | Additional content defined by implementations | ||||||
| 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. | ||||||
| Control | 0..* | ||||||
| Type | Extension | ||||||
| Is Modifier | false | ||||||
| Summary | false | ||||||
| Alternate Names | extensions, user content | ||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||||
| Slicing | This element introduces a set of slices on PractitionerRole.healthcareService.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||||
| 100. PractitionerRole.healthcareService.reference | |||||||
| Definition | A relative or absolute URL to the HealthcareService resource. | ||||||
| Short | Literal reference to the HealthcareService resource | ||||||
| Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. | ||||||
| Control | 0..1 This element is affected by the following invariants: ref-1 | ||||||
| Type | string | ||||||
| Is Modifier | false | ||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
| Summary | true | ||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
| 102. PractitionerRole.healthcareService.type | |||||||
| Definition | The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). | ||||||
| Short | Type the reference refers to (e.g. "Patient") | ||||||
| Comments | This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. | ||||||
| Control | 0..1 | ||||||
| Binding | Unless not suitable, these codes SHALL be taken from ResourceType (extensible to http://hl7.org/fhir/ValueSet/resource-types|4.0.1)Aa resource (or, for logical models, the URI of the logical model). | ||||||
| Type | uri | ||||||
| Is Modifier | false | ||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
| Summary | true | ||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
| 104. PractitionerRole.healthcareService.identifier | |||||||
| Definition | An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference. | ||||||
| Short | Logical reference, when literal reference is not known | ||||||
| Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). | ||||||
| Note | This is a business identifier, not a resource identifier (see discussion) | ||||||
| Control | 0..1 | ||||||
| Type | Identifier | ||||||
| Is Modifier | false | ||||||
| Summary | true | ||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
| 106. PractitionerRole.healthcareService.display | |||||||
| Definition | The human-readable name of the service location, used for display purposes. | ||||||
| Short | Display name of the healthcare service | ||||||
| Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. | ||||||
| Control | 0..1 | ||||||
| Type | string | ||||||
| Is Modifier | false | ||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
| Summary | true | ||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
| 108. PractitionerRole.telecom | |||||||
| Definition | Contact details that are specific to the role/location/service. | ||||||
| Short | Contact details that are specific to the role/location/service | ||||||
| Control | 0..0 | ||||||
| Type | ContactPoint | ||||||
| Is Modifier | false | ||||||
| Summary | true | ||||||
| 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. | ||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
| 110. PractitionerRole.availableTime | |||||||
| Definition | A collection of times the practitioner is available or performing this role at the location and/or healthcareservice. | ||||||
| Short | Times the Service Site is available | ||||||
| Comments | More detailed availability information may be provided in associated Schedule/Slot resources. | ||||||
| Control | 0..0 | ||||||
| Type | BackboneElement | ||||||
| Is Modifier | false | ||||||
| Summary | false | ||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
| 119. PractitionerRole.notAvailable | |||||||
| Definition | The practitioner is not available or performing this role during this period of time due to the provided reason. | ||||||
| Short | Not available during this time due to provided reason | ||||||
| Control | 0..0 | ||||||
| Type | BackboneElement | ||||||
| Is Modifier | false | ||||||
| Summary | false | ||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
| 126. PractitionerRole.availabilityExceptions | |||||||
| 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. | ||||||
| Short | Description of availability exceptions | ||||||
| Control | 0..0 | ||||||
| Type | string | ||||||
| Is Modifier | false | ||||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||||
| Summary | false | ||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||
| 128. PractitionerRole.endpoint | |||||||
| Definition | Technical endpoints providing access to services operated for the practitioner with this role. | ||||||
| Short | Technical endpoints providing access to services operated for the practitioner with this role | ||||||
| Control | 0..0 | ||||||
| Type | Reference(Endpoint) | ||||||
| Is Modifier | false | ||||||
| Summary | false | ||||||
| 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. | ||||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) | ||||||