NHSD Implementation Guide - Outbound
4.0.1 - active

NHSD Implementation Guide - Outbound - Local Development build (v4.0.1) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

## Resource Profile: NHSDPractitionerRole - Detailed Descriptions

Draft as of 2017-10-25

Definitions for the nhsd-practitionerrole resource profile.

- Key Elements Table
- Differential Elements Table
- Snapshot Elements Table

Guidance on how to interpret the contents of this table can be foundhere

0. PractitionerRole
Definition | Directory entry for a provider at a location for an organisation A specific set of Roles/Locations/specialties/services that a practitioner may perform at an organization for a period of time.
Short | A practitioner in a healthcare role in an Australian healthcare contextRoles/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-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()) dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource 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-6: A resource should have narrative for robust management (`text.div.exists()`) dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.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-6: A resource should have narrative for robust management (text.`div`.exists())
2. PractitionerRole.id
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Short | Logical 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 | id string
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 PractitionerRole resourceMetadata about the resource
Control | 10..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..01
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
8. PractitionerRole.meta.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.meta.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
10. PractitionerRole.meta.versionId
Definition | 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 | Version 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..01
Type | id
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()))
12. PractitionerRole.meta.lastUpdated
Definition | When the resource last changed - e.g. when the version changed.
Short | The timestamp when the resource was last updatedWhen 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. 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 | 10..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. 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..01
Type | uri
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
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 | ​A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url. A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url.
Short | Profiles 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 | 0..0*
Type | canonical(StructureDefinition)
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()))
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..0*
Binding | Unless not suitable, these codes SHALL be taken from All Security Labels http://hl7.org/fhir/ValueSet/security-labels (extensible to `http://hl7.org/fhir/ValueSet/security-labels` ) 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..0*
Binding | For example codes, see CommonTags http://hl7.org/fhir/ValueSet/common-tags (example to `http://hl7.org/fhir/ValueSet/common-tags` ) 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..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()))
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..01
Binding | The codes SHOULD be taken from CommonLanguages http://hl7.org/fhir/ValueSet/languages (preferred to `http://hl7.org/fhir/ValueSet/languages` ) A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
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..01
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 | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
Short | Contained, inline 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..0*
Type | Resource
Is Modifier | false
Summary | false
Alternate Names | inline resources, anonymous resources, contained resources
30. PractitionerRole.extension
Definition | An Extension May be used to represent additional information that is not part of the basic definition of the resource. 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..*
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`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
32. PractitionerRole.extension:communication
Slice Name | communication
Definition | The languages supported by Practitioner Role
Short | The languages supported by Practitioner Role
Control | 0..* This element is affected by the following invariants: ele-1
Type | Extension(nhsd-practitioner-role-communication) (Extension Type: CodeableConcept)
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())
34. 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())
36. PractitionerRole.identifier
Definition | Business identifiers for practitioner in a role. Business Identifiers that are specific to a role/location.
Short | NHSD Practitioner Role identifiersBusiness Identifiers that are specific to a role/location
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..*
Type | Identifier
Is Modifier | false
Must Support | true
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()))
Slicing | This element introduces a set of slices on `PractitionerRole.identifier`. The slices areUnordered and Open, and can be differentiated using the following discriminators: pattern @ type value @ system
38. PractitionerRole.identifier:medicareProviderNumber
Slice Name | medicareProviderNumber
Definition | Medicare provider number for this practitioner role. Business Identifiers that are specific to a role/location.
Short | Medicare Provider Number for Directory Entry Practitioner RoleBusiness Identifiers that are specific to a role/location
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..*
Type | Identifier
Is Modifier | false
Must Support | true
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()))
40. PractitionerRole.identifier:medicareProviderNumber.extension:mpnAssigningAuthority
Slice Name | mpnAssigningAuthority
Definition | Values for routing HLV2 messages, useful for PRD-7 provider identifier
Short | HL7 V2 Assigning Authority
Control | 0..1
Type | Extension(HL7 V2 Assigning Authority) (Complex Extension)
Is Modifier | false
Must Support | true
42. PractitionerRole.identifier:medicareProviderNumber.extension:mpnAssigningAuthority.extension:namespace-id
Slice Name | namespace-id
Definition | An Extension
Short | Application IdentifierAdditional content defined by implementations
Control | 0..1*
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())
44. PractitionerRole.identifier:medicareProviderNumber.extension:mpnAssigningAuthority.extension:namespace-id.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
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
Fixed Value | `namespace-id`
46. PractitionerRole.identifier:medicareProviderNumber.extension:mpnAssigningAuthority.extension:namespace-id.value[x]
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Short | Value 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
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
Slicing | This element introduces a set of slices on `PractitionerRole.identifier.extension.extension.value[x]`. The slices areUnordered and Closed, and can be differentiated using the following discriminators: type @ $this
48. PractitionerRole.identifier:medicareProviderNumber.extension:mpnAssigningAuthority.extension:namespace-id.value[x]:valueString
Slice Name | valueString
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Short | Value 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
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
50. PractitionerRole.identifier:medicareProviderNumber.extension:mpnAssigningAuthority.extension:universal-id
Slice Name | universal-id
Definition | Identifier values follwing the universal-id-type defined scheme.
Short | Universal Identifier ValueAdditional content defined by implementations
Control | 0..1*
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())
52. PractitionerRole.identifier:medicareProviderNumber.extension:mpnAssigningAuthority.extension:universal-id.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
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
Fixed Value | `universal-id`
54. PractitionerRole.identifier:medicareProviderNumber.extension:mpnAssigningAuthority.extension:universal-id.value[x]
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Short | Value 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
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
Slicing | This element introduces a set of slices on `PractitionerRole.identifier.extension.extension.value[x]`. The slices areUnordered and Closed, and can be differentiated using the following discriminators: type @ $this
56. PractitionerRole.identifier:medicareProviderNumber.extension:mpnAssigningAuthority.extension:universal-id.value[x]:valueString
Slice Name | valueString
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Short | Value 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
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
58. PractitionerRole.identifier:medicareProviderNumber.extension:mpnAssigningAuthority.extension:universal-id-type
Slice Name | universal-id-type
Definition | Provides scheme to use to interpret the universal-id value .e.g. GUID, ISO etc. see HL7 V2 Table 0301 - Universal ID type.
Short | Type Scheme of universal-idAdditional content defined by implementations
Control | 0..1*
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())
60. PractitionerRole.identifier:medicareProviderNumber.extension:mpnAssigningAuthority.extension:universal-id-type.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
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
Fixed Value | `universal-id-type`
62. PractitionerRole.identifier:medicareProviderNumber.extension:mpnAssigningAuthority.extension:universal-id-type.value[x]
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Short | Value 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
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
Slicing | This element introduces a set of slices on `PractitionerRole.identifier.extension.extension.value[x]`. The slices areUnordered and Closed, and can be differentiated using the following discriminators: type @ $this
64. PractitionerRole.identifier:medicareProviderNumber.extension:mpnAssigningAuthority.extension:universal-id-type.value[x]:valueString
Slice Name | valueString
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Short | Value 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
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
66. PractitionerRole.identifier:medicareProviderNumber.extension:mpnAssigningAuthority.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 | string uri
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
68. PractitionerRole.identifier:medicareProviderNumber.extension:mpnAssigningAuthority.value[x]
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Short | Value of extension
Control | 0..01
Type | Choice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta
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()))
70. PractitionerRole.identifier:medicareProviderNumber.use
Definition | The purpose of this identifier.
Short | usual | official | temp | secondary | old (If known)
Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
Control | 0..1
Binding | The codes SHALL be taken from IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 (required to `http://hl7.org/fhir/ValueSet/identifier-use|4.0.0` ) Identifies the purpose for this identifier, if known .
Type | code
Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
72. PractitionerRole.identifier:medicareProviderNumber.type
Definition | Identifier type of provider number for this practitioner role. A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
Short | Coded identifier type for provider numberDescription of identifier
Comments | This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.
Control | 10..1
Binding | ​The codes SHALL be taken from Unless not suitable, these codes SHALL be taken from http://hl7.org.au/fhir/ValueSet/au-hl7v2-0203 http://hl7.org/fhir/ValueSet/identifier-type (required to `http://hl7.org.au/fhir/ValueSet/au-hl7v2-0203` ) Local identifier type A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Type | CodeableConcept
Is Modifier | false
Summary | true
Requirements | Allows users to make use of identifiers when the identifier system is not known.
Pattern Value | `{ "coding" : [{ "system" : "http://terminology.hl7.org.au/CodeSystem/v2-0203", "code" : "UPIN" }] }`
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
74. PractitionerRole.identifier:medicareProviderNumber.type.text
Definition | Provider number identifier type descriptive text. A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.
Short | Plain text representation of the concept
Comments | Very often the text is the same as a displayName of one of the codings.
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
Requirements | The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.
Fixed Value | `Medicare Provider Number`
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
76. PractitionerRole.identifier:medicareProviderNumber.system
Definition | Namespace of provider number for this practitioner role. Establishes the namespace for the value - that is, a URL that describes a set values that are unique.
Short | Namespace for Medicare provider numberThe namespace for the identifier value
Comments | Identifier.system is always case sensitive.
Control | 10..1
Type | uri
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.
Fixed Value | `http://ns.electronichealth.net.au/id/medicare-provider-number`
Example | General: http://www.acme.com/identifiers/patient
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
78. PractitionerRole.identifier:medicareProviderNumber.value
Definition | Provider number for this practitioner role. The portion of the identifier typically relevant to the user and which is unique within the context of the system.
Short | Medicare provider numberThe value that is unique
Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
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
Example | General: 123456 Medicare provider number: 2426621B
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
80. PractitionerRole.identifier:nationalProviderAtOrganisation
Slice Name | nationalProviderAtOrganisation
Definition | Combined Healthcare Provider Identifier – Individual (HPI-I) and Healthcare Provider Identifier – Organisation (HPI-O) identifier to use as unique organisation based identifier for a practitioner. Business Identifiers that are specific to a role/location.
Short | National Provider at Organisation Identifier for Directory Entry Practitioner RoleBusiness 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
Must Support | true
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()))
102. PractitionerRole.identifier:employeeNumber
Slice Name | employeeNumber
Definition | Assigned identifier related to employment in this role. Business Identifiers that are specific to a role/location.
Short | Employee NumberBusiness 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()))
111. PractitionerRole.identifier:vendorAssignedDirectoryIdentifier
Slice Name | vendorAssignedDirectoryIdentifier
Definition | Vendor allocated directory identifier this can be used for search for specific practitioner role directory entry and/or for routing of messages. Business Identifiers that are specific to a role/location.
Short | Secure Messaging Vendor's Provider IdentifierBusiness Identifiers that are specific to a role/location
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..*
Type | Identifier
Is Modifier | false
Must Support | true
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()))
113. PractitionerRole.identifier:vendorAssignedDirectoryIdentifier.extension:vdiAssigningAuthority
Slice Name | vdiAssigningAuthority
Definition | Values for routing HLV2 messages, useful for PRD-7 provider identifier
Short | HL7 V2 Assigning Authority
Control | 0..1
Type | Extension(HL7 V2 Assigning Authority) (Complex Extension)
Is Modifier | false
Must Support | true
115. PractitionerRole.identifier:vendorAssignedDirectoryIdentifier.extension:vdiAssigningAuthority.extension:namespace-id
Slice Name | namespace-id
Definition | An Extension
Short | Application IdentifierAdditional content defined by implementations
Control | 0..1*
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())
117. PractitionerRole.identifier:vendorAssignedDirectoryIdentifier.extension:vdiAssigningAuthority.extension:namespace-id.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
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
Fixed Value | `namespace-id`
119. PractitionerRole.identifier:vendorAssignedDirectoryIdentifier.extension:vdiAssigningAuthority.extension:namespace-id.value[x]
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Short | Value 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
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
Slicing | This element introduces a set of slices on `PractitionerRole.identifier.extension.extension.value[x]`. The slices areUnordered and Closed, and can be differentiated using the following discriminators: type @ $this
121. PractitionerRole.identifier:vendorAssignedDirectoryIdentifier.extension:vdiAssigningAuthority.extension:namespace-id.value[x]:valueString
Slice Name | valueString
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Short | Value 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
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
123. PractitionerRole.identifier:vendorAssignedDirectoryIdentifier.extension:vdiAssigningAuthority.extension:universal-id
Slice Name | universal-id
Definition | Identifier values follwing the universal-id-type defined scheme.
Short | Universal Identifier ValueAdditional content defined by implementations
Control | 0..1*
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())
125. PractitionerRole.identifier:vendorAssignedDirectoryIdentifier.extension:vdiAssigningAuthority.extension:universal-id.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
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
Fixed Value | `universal-id`
127. PractitionerRole.identifier:vendorAssignedDirectoryIdentifier.extension:vdiAssigningAuthority.extension:universal-id.value[x]
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Short | Value 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
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
Slicing | This element introduces a set of slices on `PractitionerRole.identifier.extension.extension.value[x]`. The slices areUnordered and Closed, and can be differentiated using the following discriminators: type @ $this
129. PractitionerRole.identifier:vendorAssignedDirectoryIdentifier.extension:vdiAssigningAuthority.extension:universal-id.value[x]:valueString
Slice Name | valueString
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Short | Value 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
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
131. PractitionerRole.identifier:vendorAssignedDirectoryIdentifier.extension:vdiAssigningAuthority.extension:universal-id-type
Slice Name | universal-id-type
Definition | Provides scheme to use to interpret the universal-id value .e.g. GUID, ISO etc. see HL7 V2 Table 0301 - Universal ID type.
Short | Type Scheme of universal-idAdditional content defined by implementations
Control | 0..1*
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())
133. PractitionerRole.identifier:vendorAssignedDirectoryIdentifier.extension:vdiAssigningAuthority.extension:universal-id-type.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
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
Fixed Value | `universal-id-type`
135. PractitionerRole.identifier:vendorAssignedDirectoryIdentifier.extension:vdiAssigningAuthority.extension:universal-id-type.value[x]
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Short | Value 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
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
Slicing | This element introduces a set of slices on `PractitionerRole.identifier.extension.extension.value[x]`. The slices areUnordered and Closed, and can be differentiated using the following discriminators: type @ $this
137. PractitionerRole.identifier:vendorAssignedDirectoryIdentifier.extension:vdiAssigningAuthority.extension:universal-id-type.value[x]:valueString
Slice Name | valueString
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Short | Value 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
Summary | false
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
139. PractitionerRole.identifier:vendorAssignedDirectoryIdentifier.extension:vdiAssigningAuthority.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 | string uri
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
141. PractitionerRole.identifier:vendorAssignedDirectoryIdentifier.extension:vdiAssigningAuthority.value[x]
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Short | Value of extension
Control | 0..01
Type | Choice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta
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()))
143. PractitionerRole.identifier:vendorAssignedDirectoryIdentifier.use
Definition | The purpose of this identifier.
Short | usual | official | temp | secondary | old (If known)
Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
Control | 0..1
Binding | The codes SHALL be taken from IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 (required to `http://hl7.org/fhir/ValueSet/identifier-use|4.0.0` ) Identifies the purpose for this identifier, if known .
Type | code
Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
145. PractitionerRole.identifier:vendorAssignedDirectoryIdentifier.assigner
Definition | Organization that issued/manages the identifier.
Short | Assigning vendor referenceOrganization that issued id (may be just text)
Comments | The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.
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()))
147. PractitionerRole.identifier:vendorAssignedDirectoryIdentifier.assigner.display
Definition | Plain text narrative that identifies the resource in addition to the resource reference.
Short | Assigning vendor nameText 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()))
149. PractitionerRole.identifier:rid
Slice Name | rid
Definition | NHSD Practitioner Resource Identifier Business Identifiers that are specific to a role/location.
Short | Practitioner role identifiersBusiness Identifiers that are specific to a role/location
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..1*
Type | Identifier(nhsd-resource-identifier)
Is Modifier | false
Must Support | true
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()))
151. PractitionerRole.active
Definition | Whether this practitioner role record is in active use.
Short | Required statusWhether 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
Must Support | true
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()))
153. 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()))
155. PractitionerRole.practitioner
Definition | Australian practitioner directory entry in this role. Practitioner that is able to provide the defined services for the organization.
Short | Practitioner in the rolePractitioner that is able to provide the defined services for the organization
Control | 10..1
Type | Reference(NHSD Practitioner, Practitioner)
Is Modifier | false
Must Support | true
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
157. PractitionerRole.organization
Definition | Australian organisation directory entry providing this role. The organization where the Practitioner performs the roles associated.
Short | Organisation providing this roleOrganization where the roles are available
Control | 10..1
Type | Reference(NHSD Organisation, Organization)
Is Modifier | false
Must Support | true
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
159. PractitionerRole.code
Definition | Healthcare role code for directory lookup Roles which this practitioner is authorized to perform for the organization.
Short | Directory SNOMED-CT Practitioner Role CodeRoles which this practitioner may perform
Comments | A person may have more than one role.
Control | 10..*
Binding | The codes SHOULD be taken from For example codes, see Practitioner Specialties SNOMED-CT http://hl7.org/fhir/ValueSet/practitioner-role (preferred to `http://fhir.nhsd.com.au/ValueSet/valueset-au-nhsd-practitioner-specialties` )
Type | CodeableConcept
Is Modifier | false
Must Support | true
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()))
161. PractitionerRole.specialty
Definition | Healthcare specialties for directory lookup Specific specialty of the practitioner.
Short | Directory SNOMED-CT Practitioner SpecialtySpecific specialty of the practitioner
Control | 10..*
Binding | The codes SHOULD be taken from Practitioner Specialties SNOMED-CT http://hl7.org/fhir/ValueSet/c80-practice-codes (preferred to `http://fhir.nhsd.com.au/ValueSet/valueset-au-nhsd-practitioner-specialties` )
Type | CodeableConcept
Is Modifier | false
Must Support | true
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
163. PractitionerRole.location
Definition | Location details describing where the role is being provided. The location(s) at which this practitioner provides care.
Short | Location at which this role is providedThe location(s) at which this practitioner provides care
Control | 10..*
Type | Reference(NHSD Location, Location)
Is Modifier | false
Must Support | true
Summary | true
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
165. PractitionerRole.healthcareService
Definition | The list of healthcare services that this worker provides for this role's Organization/Location(s).
Short | Healthcare services provided in this roleThe list of healthcare services that this worker provides for this role's Organization/Location(s)
Control | 0..*
Type | Reference(NHSD HealthcareService, HealthcareService)
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()))
167. PractitionerRole.telecom
Definition | Details for contacting the practitioner in this role. Contact details that are specific to the role/location/service.
Short | Contact details for the practitioner in this role.Contact details that are specific to the role/location/service
Control | 0..0*
Type | ContactPoint
Is Modifier | false
Must Support | true
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()))
169. 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()))
172. 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()))
176. 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()))
178. PractitionerRole.endpoint
Definition | Details for service based communication with the practitioner in this role. This can include web services, messaging profiles and other protocol based communication. Technical endpoints providing access to services operated for the practitioner with this role.
Short | NHSD supports PractitionerRole to refer to maximum of one Endpoint resource (with corresponding SMD Target identifier) per secure messaging vendor productTechnical endpoints providing access to services operated for the practitioner with this role
Control | 0..*
Type | Reference(NHSD Secure Messaging Endpoint, Endpoint)
Is Modifier | false
Must Support | true
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
Definition | Directory entry for a provider at a location for an organisation
2. PractitionerRole.id
Control | 1..?
4. PractitionerRole.meta
Short | Metadata about PractitionerRole resource
Control | 1..?
6. PractitionerRole.meta.id
Control | 0..0
8. PractitionerRole.meta.extension
Control | 0..0
10. PractitionerRole.meta.versionId
Control | 0..0
12. PractitionerRole.meta.lastUpdated
Short | The timestamp when the resource was last updated
Control | 1..?
14. PractitionerRole.meta.source
Control | 0..0
16. PractitionerRole.meta.profile
Control | 0..0
18. PractitionerRole.meta.security
Control | 0..0
20. PractitionerRole.meta.tag
Control | 0..0
22. PractitionerRole.implicitRules
Control | 0..0
24. PractitionerRole.language
Control | 0..0
26. PractitionerRole.text
Control | 0..0
28. PractitionerRole.contained
Control | 0..0
30. PractitionerRole.extension
Slicing | This element introduces a set of slices on `PractitionerRole.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
32. PractitionerRole.extension:communication
Slice Name | communication
Definition | The languages supported by Practitioner Role
Short | The languages supported by Practitioner Role
Type | Extension(nhsd-practitioner-role-communication) (Extension Type: CodeableConcept)
34. PractitionerRole.modifierExtension
Control | 0..0
36. PractitionerRole.identifier
Short | NHSD Practitioner Role identifiers
Note | This is a business identifier, not a resource identifier (see discussion)
Slicing | This element introduces a set of slices on `PractitionerRole.identifier`. The slices areUnordered and Open, and defines no disciminators to differentiate the slices
38. PractitionerRole.identifier:nationalProviderAtOrganisation
Slice Name | nationalProviderAtOrganisation
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..0
40. PractitionerRole.identifier:employeeNumber
Slice Name | employeeNumber
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..0
42. PractitionerRole.identifier:rid
Slice Name | rid
Definition | NHSD Practitioner Resource Identifier
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..1
Type | Identifier(nhsd-resource-identifier)
Is Modifier | false
Must Support | true
44. PractitionerRole.period
Control | 0..0
46. PractitionerRole.practitioner
Type | Reference(NHSD Practitioner)
48. PractitionerRole.organization
Type | Reference(NHSD Organisation)
50. PractitionerRole.code
Control | 1..*
Binding | The codes SHOULD be taken from Practitioner Specialties SNOMED-CT (preferred to `http://fhir.nhsd.com.au/ValueSet/valueset-au-nhsd-practitioner-specialties` )
52. PractitionerRole.specialty
Control | 1..*
Binding | The codes SHOULD be taken from Practitioner Specialties SNOMED-CT (preferred to `http://fhir.nhsd.com.au/ValueSet/valueset-au-nhsd-practitioner-specialties` )
54. PractitionerRole.location
Type | Reference(NHSD Location)
56. PractitionerRole.healthcareService
Type | Reference(NHSD HealthcareService)
58. PractitionerRole.telecom
Control | 0..0
60. PractitionerRole.availableTime
Control | 0..0
62. PractitionerRole.notAvailable
Control | 0..0
64. PractitionerRole.availabilityExceptions
Control | 0..0
66. PractitionerRole.endpoint
Short | NHSD supports PractitionerRole to refer to maximum of one Endpoint resource (with corresponding SMD Target identifier) per secure messaging vendor product
Control | 0..*
Type | Reference(NHSD Secure Messaging Endpoint)
Is Modifier | false
Must Support | true

Guidance on how to interpret the contents of this table can be foundhere

0. PractitionerRole
Definition | Directory entry for a provider at a location for an organisation
Short | A practitioner in a healthcare role in an Australian healthcare context
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-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (`contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()`) dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource 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-6: A resource should have narrative for robust management (`text.div.exists()`) dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (`contained.meta.security.empty()`)
2. PractitionerRole.id
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Short | Logical 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 | 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 PractitionerRole resource
Control | 1..1
Type | Meta
Is Modifier | false
Summary | true
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..0
Type | string
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
8. PractitionerRole.meta.extension
Definition | An Extension
Short | Extension
Control | 0..0
Type | Extension
Is Modifier | false
Summary | false
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: value @ url
10. PractitionerRole.meta.versionId
Definition | 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 | Version 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..0
Type | id
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
12. PractitionerRole.meta.lastUpdated
Definition | When the resource last changed - e.g. when the version changed.
Short | The timestamp when the resource was last updated
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 | 1..1
Type | instant
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
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..0
Type | uri
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Must Support | true
Summary | true
16. PractitionerRole.meta.profile
Definition | ​A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url.
Short | Profiles 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 | 0..0
Type | canonical(StructureDefinition)
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
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..0
Binding | Unless not suitable, these codes SHALL be taken from All Security Labels (extensible to `http://hl7.org/fhir/ValueSet/security-labels` ) Security Labels from the Healthcare Privacy and Security Classification System.
Type | Coding
Is Modifier | false
Summary | true
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..0
Binding | For example codes, see CommonTags (example to `http://hl7.org/fhir/ValueSet/common-tags` ) Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
Type | Coding
Is Modifier | false
Summary | true
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
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..0
Binding | The codes SHOULD be taken from CommonLanguages (preferred to `http://hl7.org/fhir/ValueSet/languages` ) A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
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..0
Type | Narrative
Is Modifier | false
Summary | false
Alternate Names | narrative, html, xhtml, display
28. PractitionerRole.contained
Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
Short | Contained, inline 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..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
Slicing | This element introduces a set of slices on `PractitionerRole.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
32. PractitionerRole.extension:communication
Slice Name | communication
Definition | The languages supported by Practitioner Role
Short | The languages supported by Practitioner Role
Control | 0..* This element is affected by the following invariants: ele-1
Type | Extension(nhsd-practitioner-role-communication) (Extension Type: CodeableConcept)
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.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
36. PractitionerRole.identifier
Definition | Business identifiers for practitioner in a role.
Short | NHSD Practitioner Role identifiers
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..*
Type | Identifier
Is Modifier | false
Must Support | true
Summary | true
Requirements | Often, specific identities are assigned for the agent.
Slicing | This element introduces a set of slices on `PractitionerRole.identifier`. The slices areUnordered and Open, and can be differentiated using the following discriminators: pattern @ type value @ system
38. PractitionerRole.identifier:medicareProviderNumber
Slice Name | medicareProviderNumber
Definition | Medicare provider number for this practitioner role.
Short | Medicare Provider Number for Directory Entry Practitioner Role
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..*
Type | Identifier
Is Modifier | false
Must Support | true
Summary | true
Requirements | Often, specific identities are assigned for the agent.
40. PractitionerRole.identifier:medicareProviderNumber.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
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
42. PractitionerRole.identifier:medicareProviderNumber.extension
Definition | An Extension
Short | Extension
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Slicing | This element introduces a set of slices on `PractitionerRole.identifier.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
44. PractitionerRole.identifier:medicareProviderNumber.extension:mpnAssigningAuthority
Slice Name | mpnAssigningAuthority
Definition | Values for routing HLV2 messages, useful for PRD-7 provider identifier
Short | HL7 V2 Assigning Authority
Control | 0..1
Type | Extension(HL7 V2 Assigning Authority) (Complex Extension)
Is Modifier | false
Must Support | true
46. PractitionerRole.identifier:medicareProviderNumber.extension:mpnAssigningAuthority.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
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
48. PractitionerRole.identifier:medicareProviderNumber.extension:mpnAssigningAuthority.extension
Definition | An Extension
Short | Extension
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Slicing | This element introduces a set of slices on `PractitionerRole.identifier.extension.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
50. PractitionerRole.identifier:medicareProviderNumber.extension:mpnAssigningAuthority.extension:namespace-id
Slice Name | namespace-id
Definition | An Extension
Short | Application Identifier
Control | 0..1
Type | Extension
Is Modifier | false
Summary | false
52. PractitionerRole.identifier:medicareProviderNumber.extension:mpnAssigningAuthority.extension:namespace-id.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
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
54. PractitionerRole.identifier:medicareProviderNumber.extension:mpnAssigningAuthority.extension:namespace-id.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
Slicing | This element introduces a set of slices on `PractitionerRole.identifier.extension.extension.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
56. PractitionerRole.identifier:medicareProviderNumber.extension:mpnAssigningAuthority.extension:namespace-id.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
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
Fixed Value | `namespace-id`
58. PractitionerRole.identifier:medicareProviderNumber.extension:mpnAssigningAuthority.extension:namespace-id.value[x]
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Short | Value of extension
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
Summary | false
Slicing | This element introduces a set of slices on `PractitionerRole.identifier.extension.extension.value[x]`. The slices areUnordered and Closed, and can be differentiated using the following discriminators: type @ $this
60. PractitionerRole.identifier:medicareProviderNumber.extension:mpnAssigningAuthority.extension:namespace-id.value[x]:valueString
Slice Name | valueString
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Short | Value of extension
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
Summary | false
62. PractitionerRole.identifier:medicareProviderNumber.extension:mpnAssigningAuthority.extension:universal-id
Slice Name | universal-id
Definition | Identifier values follwing the universal-id-type defined scheme.
Short | Universal Identifier Value
Control | 0..1
Type | Extension
Is Modifier | false
Summary | false
64. PractitionerRole.identifier:medicareProviderNumber.extension:mpnAssigningAuthority.extension:universal-id.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
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
66. PractitionerRole.identifier:medicareProviderNumber.extension:mpnAssigningAuthority.extension:universal-id.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
Slicing | This element introduces a set of slices on `PractitionerRole.identifier.extension.extension.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
68. PractitionerRole.identifier:medicareProviderNumber.extension:mpnAssigningAuthority.extension:universal-id.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
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
Fixed Value | `universal-id`
70. PractitionerRole.identifier:medicareProviderNumber.extension:mpnAssigningAuthority.extension:universal-id.value[x]
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Short | Value of extension
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
Summary | false
Slicing | This element introduces a set of slices on `PractitionerRole.identifier.extension.extension.value[x]`. The slices areUnordered and Closed, and can be differentiated using the following discriminators: type @ $this
72. PractitionerRole.identifier:medicareProviderNumber.extension:mpnAssigningAuthority.extension:universal-id.value[x]:valueString
Slice Name | valueString
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Short | Value of extension
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
Summary | false
74. PractitionerRole.identifier:medicareProviderNumber.extension:mpnAssigningAuthority.extension:universal-id-type
Slice Name | universal-id-type
Definition | Provides scheme to use to interpret the universal-id value .e.g. GUID, ISO etc. see HL7 V2 Table 0301 - Universal ID type.
Short | Type Scheme of universal-id
Control | 0..1
Type | Extension
Is Modifier | false
Summary | false
76. PractitionerRole.identifier:medicareProviderNumber.extension:mpnAssigningAuthority.extension:universal-id-type.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
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
78. PractitionerRole.identifier:medicareProviderNumber.extension:mpnAssigningAuthority.extension:universal-id-type.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
Slicing | This element introduces a set of slices on `PractitionerRole.identifier.extension.extension.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
80. PractitionerRole.identifier:medicareProviderNumber.extension:mpnAssigningAuthority.extension:universal-id-type.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
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
Fixed Value | `universal-id-type`
82. PractitionerRole.identifier:medicareProviderNumber.extension:mpnAssigningAuthority.extension:universal-id-type.value[x]
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Short | Value of extension
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
Summary | false
Slicing | This element introduces a set of slices on `PractitionerRole.identifier.extension.extension.value[x]`. The slices areUnordered and Closed, and can be differentiated using the following discriminators: type @ $this
84. PractitionerRole.identifier:medicareProviderNumber.extension:mpnAssigningAuthority.extension:universal-id-type.value[x]:valueString
Slice Name | valueString
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Short | Value of extension
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
Summary | false
86. PractitionerRole.identifier:medicareProviderNumber.extension:mpnAssigningAuthority.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 | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
88. PractitionerRole.identifier:medicareProviderNumber.extension:mpnAssigningAuthority.value[x]
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Short | Value of extension
Control | 0..0
Type | Choice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
90. PractitionerRole.identifier:medicareProviderNumber.use
Definition | The purpose of this identifier.
Short | usual | official | temp | secondary | old (If known)
Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
Control | 0..1
Binding | The codes SHALL be taken from IdentifierUse (required to `http://hl7.org/fhir/ValueSet/identifier-use|4.0.0` ) Identifies the purpose for this identifier, if known .
Type | code
Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.
92. PractitionerRole.identifier:medicareProviderNumber.type
Definition | Identifier type of provider number for this practitioner role.
Short | Coded identifier type for provider number
Comments | This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.
Control | 1..1
Binding | ​The codes SHALL be taken from http://hl7.org.au/fhir/ValueSet/au-hl7v2-0203 (required to `http://hl7.org.au/fhir/ValueSet/au-hl7v2-0203` ) Local identifier type
Type | CodeableConcept
Is Modifier | false
Summary | true
Requirements | Allows users to make use of identifiers when the identifier system is not known.
Pattern Value | `{ "coding" : [{ "system" : "http://terminology.hl7.org.au/CodeSystem/v2-0203", "code" : "UPIN" }] }`
94. PractitionerRole.identifier:medicareProviderNumber.type.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
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
96. PractitionerRole.identifier:medicareProviderNumber.type.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
Slicing | This element introduces a set of slices on `PractitionerRole.identifier.type.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
98. PractitionerRole.identifier:medicareProviderNumber.type.coding
Definition | A reference to a code defined by a terminology system.
Short | Code defined by a terminology system
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
Control | 0..*
Type | Coding
Is Modifier | false
Summary | true
Requirements | Allows for alternative encodings within a code system, and translations to other code systems.
100. PractitionerRole.identifier:medicareProviderNumber.type.text
Definition | Provider number identifier type descriptive text.
Short | Plain text representation of the concept
Comments | Very often the text is the same as a displayName of one of the codings.
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
Requirements | The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.
Fixed Value | `Medicare Provider Number`
102. PractitionerRole.identifier:medicareProviderNumber.system
Definition | Namespace of provider number for this practitioner role.
Short | Namespace for Medicare provider number
Comments | Identifier.system is always case sensitive.
Control | 1..1
Type | uri
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.
Fixed Value | `http://ns.electronichealth.net.au/id/medicare-provider-number`
Example | General: http://www.acme.com/identifiers/patient
104. PractitionerRole.identifier:medicareProviderNumber.value
Definition | Provider number for this practitioner role.
Short | Medicare provider number
Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
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
Example | General: 123456 Medicare provider number: 2426621B
106. PractitionerRole.identifier:medicareProviderNumber.period
Definition | Time period during which identifier is/was valid for use.
Short | Time period when id is/was valid for use
Control | 0..1
Type | Period
Is Modifier | false
Summary | true
108. PractitionerRole.identifier:medicareProviderNumber.assigner
Definition | Organization that issued/manages the identifier.
Short | Organization that issued id (may be just text)
Comments | The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.
Control | 0..1
Type | Reference(Organization)
Is Modifier | false
Summary | true
110. PractitionerRole.identifier:nationalProviderAtOrganisation
Slice Name | nationalProviderAtOrganisation
Definition | Combined Healthcare Provider Identifier – Individual (HPI-I) and Healthcare Provider Identifier – Organisation (HPI-O) identifier to use as unique organisation based identifier for a practitioner.
Short | National Provider at Organisation Identifier for Directory Entry Practitioner Role
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..0
Type | Identifier
Is Modifier | false
Must Support | true
Summary | true
Requirements | Often, specific identities are assigned for the agent.
147. PractitionerRole.identifier:employeeNumber
Slice Name | employeeNumber
Definition | Assigned identifier related to employment in this role.
Short | Employee Number
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.
167. PractitionerRole.identifier:vendorAssignedDirectoryIdentifier
Slice Name | vendorAssignedDirectoryIdentifier
Definition | Vendor allocated directory identifier this can be used for search for specific practitioner role directory entry and/or for routing of messages.
Short | Secure Messaging Vendor's Provider Identifier
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..*
Type | Identifier
Is Modifier | false
Must Support | true
Summary | true
Requirements | Often, specific identities are assigned for the agent.
169. PractitionerRole.identifier:vendorAssignedDirectoryIdentifier.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
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
171. PractitionerRole.identifier:vendorAssignedDirectoryIdentifier.extension
Definition | An Extension
Short | Extension
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Slicing | This element introduces a set of slices on `PractitionerRole.identifier.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
173. PractitionerRole.identifier:vendorAssignedDirectoryIdentifier.extension:vdiAssigningAuthority
Slice Name | vdiAssigningAuthority
Definition | Values for routing HLV2 messages, useful for PRD-7 provider identifier
Short | HL7 V2 Assigning Authority
Control | 0..1
Type | Extension(HL7 V2 Assigning Authority) (Complex Extension)
Is Modifier | false
Must Support | true
175. PractitionerRole.identifier:vendorAssignedDirectoryIdentifier.extension:vdiAssigningAuthority.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
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
177. PractitionerRole.identifier:vendorAssignedDirectoryIdentifier.extension:vdiAssigningAuthority.extension
Definition | An Extension
Short | Extension
Control | 0..*
Type | Extension
Is Modifier | false
Summary | false
Slicing | This element introduces a set of slices on `PractitionerRole.identifier.extension.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
179. PractitionerRole.identifier:vendorAssignedDirectoryIdentifier.extension:vdiAssigningAuthority.extension:namespace-id
Slice Name | namespace-id
Definition | An Extension
Short | Application Identifier
Control | 0..1
Type | Extension
Is Modifier | false
Summary | false
181. PractitionerRole.identifier:vendorAssignedDirectoryIdentifier.extension:vdiAssigningAuthority.extension:namespace-id.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
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
183. PractitionerRole.identifier:vendorAssignedDirectoryIdentifier.extension:vdiAssigningAuthority.extension:namespace-id.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
Slicing | This element introduces a set of slices on `PractitionerRole.identifier.extension.extension.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
185. PractitionerRole.identifier:vendorAssignedDirectoryIdentifier.extension:vdiAssigningAuthority.extension:namespace-id.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
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
Fixed Value | `namespace-id`
187. PractitionerRole.identifier:vendorAssignedDirectoryIdentifier.extension:vdiAssigningAuthority.extension:namespace-id.value[x]
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Short | Value of extension
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
Summary | false
Slicing | This element introduces a set of slices on `PractitionerRole.identifier.extension.extension.value[x]`. The slices areUnordered and Closed, and can be differentiated using the following discriminators: type @ $this
189. PractitionerRole.identifier:vendorAssignedDirectoryIdentifier.extension:vdiAssigningAuthority.extension:namespace-id.value[x]:valueString
Slice Name | valueString
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Short | Value of extension
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
Summary | false
191. PractitionerRole.identifier:vendorAssignedDirectoryIdentifier.extension:vdiAssigningAuthority.extension:universal-id
Slice Name | universal-id
Definition | Identifier values follwing the universal-id-type defined scheme.
Short | Universal Identifier Value
Control | 0..1
Type | Extension
Is Modifier | false
Summary | false
193. PractitionerRole.identifier:vendorAssignedDirectoryIdentifier.extension:vdiAssigningAuthority.extension:universal-id.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
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
195. PractitionerRole.identifier:vendorAssignedDirectoryIdentifier.extension:vdiAssigningAuthority.extension:universal-id.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
Slicing | This element introduces a set of slices on `PractitionerRole.identifier.extension.extension.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
197. PractitionerRole.identifier:vendorAssignedDirectoryIdentifier.extension:vdiAssigningAuthority.extension:universal-id.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
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
Fixed Value | `universal-id`
199. PractitionerRole.identifier:vendorAssignedDirectoryIdentifier.extension:vdiAssigningAuthority.extension:universal-id.value[x]
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Short | Value of extension
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
Summary | false
Slicing | This element introduces a set of slices on `PractitionerRole.identifier.extension.extension.value[x]`. The slices areUnordered and Closed, and can be differentiated using the following discriminators: type @ $this
201. PractitionerRole.identifier:vendorAssignedDirectoryIdentifier.extension:vdiAssigningAuthority.extension:universal-id.value[x]:valueString
Slice Name | valueString
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Short | Value of extension
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
Summary | false
203. PractitionerRole.identifier:vendorAssignedDirectoryIdentifier.extension:vdiAssigningAuthority.extension:universal-id-type
Slice Name | universal-id-type
Definition | Provides scheme to use to interpret the universal-id value .e.g. GUID, ISO etc. see HL7 V2 Table 0301 - Universal ID type.
Short | Type Scheme of universal-id
Control | 0..1
Type | Extension
Is Modifier | false
Summary | false
205. PractitionerRole.identifier:vendorAssignedDirectoryIdentifier.extension:vdiAssigningAuthority.extension:universal-id-type.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
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
207. PractitionerRole.identifier:vendorAssignedDirectoryIdentifier.extension:vdiAssigningAuthority.extension:universal-id-type.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
Slicing | This element introduces a set of slices on `PractitionerRole.identifier.extension.extension.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
209. PractitionerRole.identifier:vendorAssignedDirectoryIdentifier.extension:vdiAssigningAuthority.extension:universal-id-type.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
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
Fixed Value | `universal-id-type`
211. PractitionerRole.identifier:vendorAssignedDirectoryIdentifier.extension:vdiAssigningAuthority.extension:universal-id-type.value[x]
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Short | Value of extension
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
Summary | false
Slicing | This element introduces a set of slices on `PractitionerRole.identifier.extension.extension.value[x]`. The slices areUnordered and Closed, and can be differentiated using the following discriminators: type @ $this
213. PractitionerRole.identifier:vendorAssignedDirectoryIdentifier.extension:vdiAssigningAuthority.extension:universal-id-type.value[x]:valueString
Slice Name | valueString
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Short | Value of extension
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
Summary | false
215. PractitionerRole.identifier:vendorAssignedDirectoryIdentifier.extension:vdiAssigningAuthority.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 | string
Is Modifier | false
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
217. PractitionerRole.identifier:vendorAssignedDirectoryIdentifier.extension:vdiAssigningAuthority.value[x]
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Short | Value of extension
Control | 0..0
Type | Choice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | false
219. PractitionerRole.identifier:vendorAssignedDirectoryIdentifier.use
Definition | The purpose of this identifier.
Short | usual | official | temp | secondary | old (If known)
Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
Control | 0..1
Binding | The codes SHALL be taken from IdentifierUse (required to `http://hl7.org/fhir/ValueSet/identifier-use|4.0.0` ) Identifies the purpose for this identifier, if known .
Type | code
Is Modifier | true because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.
221. PractitionerRole.identifier:vendorAssignedDirectoryIdentifier.type
Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
Short | Vendor assigned directory identifier type
Comments | This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.
Control | 0..1
Binding | Unless not suitable, these codes SHALL be taken from Identifier Type Codes (extensible to `http://hl7.org/fhir/ValueSet/identifier-type` ) A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
Type | CodeableConcept
Is Modifier | false
Summary | true
Requirements | Allows users to make use of identifiers when the identifier system is not known.
223. PractitionerRole.identifier:vendorAssignedDirectoryIdentifier.type.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
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
225. PractitionerRole.identifier:vendorAssignedDirectoryIdentifier.type.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
Slicing | This element introduces a set of slices on `PractitionerRole.identifier.type.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
227. PractitionerRole.identifier:vendorAssignedDirectoryIdentifier.type.coding
Definition | A reference to a code defined by a terminology system.
Short | Vendor assigned directory identifier type code
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
Control | 1..*
Type | Coding
Is Modifier | false
Summary | true
Requirements | Allows for alternative encodings within a code system, and translations to other code systems.
229. PractitionerRole.identifier:vendorAssignedDirectoryIdentifier.type.coding.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
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
231. PractitionerRole.identifier:vendorAssignedDirectoryIdentifier.type.coding.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
Slicing | This element introduces a set of slices on `PractitionerRole.identifier.type.coding.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
233. PractitionerRole.identifier:vendorAssignedDirectoryIdentifier.type.coding.system
Definition | The identification of the code system that defines the meaning of the symbol in the code.
Short | Vendor assigned directory identifier type coding system
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.
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
Requirements | Need to be unambiguous about the source of the definition of the symbol.
235. PractitionerRole.identifier:vendorAssignedDirectoryIdentifier.type.coding.version
Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
Short | Version of the system - if relevant
Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.
Note | This is a business version Id, not a resource version Id (see discussion)
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
237. PractitionerRole.identifier:vendorAssignedDirectoryIdentifier.type.coding.code
Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
Short | Symbol in syntax defined by the system
Control | 0..1
Type | code
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | Need to refer to a particular code in the system.
Fixed Value | `VDI`
239. PractitionerRole.identifier:vendorAssignedDirectoryIdentifier.type.coding.display
Definition | A representation of the meaning of the code in the system, following the rules of the system.
Short | Representation defined by the system
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
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system.
241. PractitionerRole.identifier:vendorAssignedDirectoryIdentifier.type.coding.userSelected
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
Short | If this coding was chosen directly by the user
Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.
Control | 0..1
Type | boolean
Is Modifier | false
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
Summary | true
Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.
243. PractitionerRole.identifier:vendorAssignedDirectoryIdentifier.type.text
Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.
Short | Plain text representation of the concept
Comments | Very often the text is the same as a displayName of one of the codings.
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
Requirements | The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.
Fixed Value | `Secure Messaging Vendor Identifier Directory Entry`
245. PractitionerRole.identifier:vendorAssignedDirectoryIdentifier.system
Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique.
Short | Required vendor assigned identifier system URI
Comments | Identifier.system is always case sensitive.
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
Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.
Example | General: http://www.acme.com/identifiers/patient
247. PractitionerRole.identifier:vendorAssignedDirectoryIdentifier.value
Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system.
Short | The value that is unique
Comments | ​If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
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
Example | General: 123456
249. PractitionerRole.identifier:vendorAssignedDirectoryIdentifier.period
Definition | Time period during which identifier is/was valid for use.
Short | Time period when id is/was valid for use
Control | 0..1
Type | Period
Is Modifier | false
Summary | true
251. PractitionerRole.identifier:vendorAssignedDirectoryIdentifier.assigner
Definition | Organization that issued/manages the identifier.
Short | Assigning vendor reference
Comments | The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.
Control | 1..1
Type | Reference(Organization)
Is Modifier | false
Summary | true
253. PractitionerRole.identifier:vendorAssignedDirectoryIdentifier.assigner.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
Primitive Value | This primitive element may be present, or absent, or replaced by an extension
XML Format | In the XML format, this property is represented as an attribute.
Summary | false
255. PractitionerRole.identifier:vendorAssignedDirectoryIdentifier.assigner.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
Slicing | This element introduces a set of slices on `PractitionerRole.identifier.assigner.extension`. The slices areUnordered and Open, and can be differentiated using the following discriminators: value @ url
257. PractitionerRole.identifier:vendorAssignedDirectoryIdentifier.assigner.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..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
259. PractitionerRole.identifier:vendorAssignedDirectoryIdentifier.assigner.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` ) 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
261. PractitionerRole.identifier:vendorAssignedDirectoryIdentifier.assigner.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
263. PractitionerRole.identifier:vendorAssignedDirectoryIdentifier.assigner.display
Definition | Plain text narrative that identifies the resource in addition to the resource reference.
Short | Assigning vendor name
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
265. PractitionerRole.identifier:rid
Slice Name | rid
Definition | NHSD Practitioner Resource Identifier
Short | Practitioner role identifiers
Note | This is a business identifier, not a resource identifier (see discussion)
Control | 0..1
Type | Identifier(nhsd-resource-identifier)
Is Modifier | false
Must Support | true
Summary | true
Requirements | Often, specific identities are assigned for the agent.
267. PractitionerRole.active
Definition | Whether this practitioner role record is in active use.
Short | Required status
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
Must Support | true
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
269. 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.
271. PractitionerRole.practitioner
Definition | Australian practitioner directory entry in this role.
Short | Practitioner in the role
Control | 1..1
Type | Reference(NHSD Practitioner)
Is Modifier | false
Must Support | true
Summary | true
273. PractitionerRole.organization
Definition | Australian organisation directory entry providing this role.
Short | Organisation providing this role
Control | 1..1
Type | Reference(NHSD Organisation)
Is Modifier | false
Must Support | true
Summary | true
275. PractitionerRole.code
Definition | Healthcare role code for directory lookup
Short | Directory SNOMED-CT Practitioner Role Code
Comments | A person may have more than one role.
Control | 1..*
Binding | The codes SHOULD be taken from Practitioner Specialties SNOMED-CT (preferred to `http://fhir.nhsd.com.au/ValueSet/valueset-au-nhsd-practitioner-specialties` )
Type | CodeableConcept
Is Modifier | false
Must Support | true
Summary | true
Requirements | Need to know what authority the practitioner has - what can they do?
277. PractitionerRole.specialty
Definition | Healthcare specialties for directory lookup
Short | Directory SNOMED-CT Practitioner Specialty
Control | 1..*
Binding | The codes SHOULD be taken from Practitioner Specialties SNOMED-CT (preferred to `http://fhir.nhsd.com.au/ValueSet/valueset-au-nhsd-practitioner-specialties` )
Type | CodeableConcept
Is Modifier | false
Must Support | true
Summary | true
279. PractitionerRole.location
Definition | Location details describing where the role is being provided.
Short | Location at which this role is provided
Control | 1..*
Type | Reference(NHSD Location)
Is Modifier | false
Must Support | true
Summary | true
281. PractitionerRole.healthcareService
Definition | The list of healthcare services that this worker provides for this role's Organization/Location(s).
Short | Healthcare services provided in this role
Control | 0..*
Type | Reference(NHSD HealthcareService)
Is Modifier | false
Must Support | true
Summary | false
283. PractitionerRole.telecom
Definition | Details for contacting the practitioner in this role.
Short | Contact details for the practitioner in this role.
Control | 0..0
Type | ContactPoint
Is Modifier | false
Must Support | true
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.
285. 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())`)
294. 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())`)
301. 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
303. PractitionerRole.endpoint
Definition | Details for service based communication with the practitioner in this role. This can include web services, messaging profiles and other protocol based communication.
Short | NHSD supports PractitionerRole to refer to maximum of one Endpoint resource (with corresponding SMD Target identifier) per secure messaging vendor product
Control | 0..*
Type | Reference(NHSD Secure Messaging Endpoint)
Is Modifier | false
Must Support | true
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.