Interweave Implementation Guide
0.1.0 - ci-build United Kingdom flag

Interweave Implementation Guide - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the STU3 profiles here.

Resource Profile: InterweavePractitionerRole - Detailed Descriptions

Draft as of 2024-07-15

Definitions for the Interweave-PractitionerRole resource profile.

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

0. PractitionerRole
2. PractitionerRole.id
Must Supporttrue
4. PractitionerRole.meta
6. PractitionerRole.meta.id
Control0..0
8. PractitionerRole.meta.versionId
Must Supporttrue
10. PractitionerRole.meta.lastUpdated
ShortMANDATORY except in Contained Resources. When the resource version last changed.
Must Supporttrue
12. PractitionerRole.meta.profile
ShortProfiles this resource claims to conform to. Should list (i) this profile (ii) base profile for this resource.
Must Supporttrue
14. PractitionerRole.meta.security
ShortDISCOURAGED - may not be honoured by Data Consumers
16. PractitionerRole.meta.tag
SlicingThis element introduces a set of slices on PractitionerRole.meta.tag. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ system
  • 18. PractitionerRole.meta.tag:Source
    Slice NameSource
    ShortMANDATORY except in Contained Resources. The Data Provider Id (and display text) of the system supplying the data
    Control0..1
    Must Supporttrue
    20. PractitionerRole.meta.tag:Source.id
    Control0..0
    22. PractitionerRole.meta.tag:Source.system
    Control1..?
    Fixed Valuehttps://fhir.interweavedigital.nhs.uk/Source
    24. PractitionerRole.meta.tag:Source.version
    NoteThis is a business version Id, not a resource version Id (see discussion)
    Control0..0
    26. PractitionerRole.meta.tag:Source.code
    ShortThe Data Provider Id of the system supplying the data
    Control1..?
    Must Supporttrue
    28. PractitionerRole.meta.tag:Source.display
    ShortName of the system supplying the data
    Control1..?
    Must Supporttrue
    30. PractitionerRole.meta.tag:Provenance
    Slice NameProvenance
    ShortMANDATORY except in Contained Resources. The ODS Code (and display text) of the organisation responsible for the data
    Control0..1
    Must Supporttrue
    32. PractitionerRole.meta.tag:Provenance.id
    Control0..0
    34. PractitionerRole.meta.tag:Provenance.system
    Control1..?
    Fixed Valuehttps://fhir.interweavedigital.nhs.uk/Provenance
    36. PractitionerRole.meta.tag:Provenance.version
    NoteThis is a business version Id, not a resource version Id (see discussion)
    Control0..0
    38. PractitionerRole.meta.tag:Provenance.code
    ShortThe ODS Code of the organisation responsible for the data
    Control1..?
    Must Supporttrue
    40. PractitionerRole.meta.tag:Provenance.display
    ShortName of the organisation supplying the data
    Control1..?
    Must Supporttrue
    42. PractitionerRole.implicitRules
    ShortDISCOURAGED - may not be honoured by Data Consumers
    44. PractitionerRole.language
    ShortEnglish is assumed (not currently a multi-lingual implementation)
    46. PractitionerRole.text
    ShortDISCOURAGED - the preferred approach is to offer structured data fields which a Data Consumer can then render and present in a manner most suited to its users
    48. PractitionerRole.extension
    SlicingThis element introduces a set of slices on PractitionerRole.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • value @ url
    • 50. PractitionerRole.extension:serviceType
      Slice NameserviceType
      ShortThe services which the practitioner can offer.
      Control0..*
      TypeExtension(ExtensionInterweaveServiceType) (Extension Type: CodeableConcept)
      Must Supporttrue
      52. PractitionerRole.identifier
      NoteThis is a business identifier, not a resource identifier (see discussion)
      54. PractitionerRole.identifier.id
      Control0..0
      56. PractitionerRole.identifier.extension
      Control0..0
      58. PractitionerRole.identifier.system
      Control1..?
      Must Supporttrue
      60. PractitionerRole.identifier.value
      Control1..?
      Must Supporttrue
      62. PractitionerRole.identifier.assigner
      TypeReference(InterweaveOrganization)
      64. PractitionerRole.active
      ShortWhether this practitioner's “role” record is in active use.
      Control1..?
      66. PractitionerRole.practitioner
      ShortThe practitioner that is able to provide the defined services for the organisation.
      Control1..?
      TypeReference(InterweavePractitioner)
      68. PractitionerRole.practitioner.id
      Control0..0
      70. PractitionerRole.practitioner.extension
      Control0..0
      72. PractitionerRole.practitioner.reference
      ShortReference to a resource (could be Contained)
      Control1..?
      74. PractitionerRole.practitioner.type
      Control0..0
      76. PractitionerRole.practitioner.identifier
      ShortIf relevant could include an id
      NoteThis is a business identifier, not a resource identifier (see discussion)
      78. PractitionerRole.practitioner.display
      ShortDescription of the referenced resource
      Control1..?
      80. PractitionerRole.organization
      ShortThe organization where the Practitioner performs the roles associated.
      TypeReference(InterweaveOrganization)
      82. PractitionerRole.organization.id
      Control0..0
      84. PractitionerRole.organization.extension
      Control0..0
      86. PractitionerRole.organization.reference
      ShortReference to a resource (could be Contained)
      Control1..?
      88. PractitionerRole.organization.type
      Control0..0
      90. PractitionerRole.organization.identifier
      ShortIf relevant could include an id
      NoteThis is a business identifier, not a resource identifier (see discussion)
      92. PractitionerRole.organization.display
      ShortDescription of the referenced resource
      Control1..?
      94. PractitionerRole.code
      Control1..?
      BindingThe codes SHOULD be taken from PractitionerRole
      (preferred to http://hl7.org/fhir/ValueSet/practitioner-role)
      Must Supporttrue
      SlicingThis element introduces a set of slices on PractitionerRole.code. The slices areUnordered and Open, and can be differentiated using the following discriminators:
      • value @ coding.system
      • 96. PractitionerRole.code.coding
        98. PractitionerRole.code.coding.id
        Control0..0
        100. PractitionerRole.code.coding.system
        Control1..?
        102. PractitionerRole.code.coding.version
        NoteThis is a business version Id, not a resource version Id (see discussion)
        Control0..0
        104. PractitionerRole.code.coding.code
        Control1..?
        106. PractitionerRole.code.coding.display
        Control1..?
        108. PractitionerRole.code:SDSJobRoleName
        Slice NameSDSJobRoleName
        Control0..1
        BindingThe codes SHOULD be taken from InterweaveSDSJobRoleName
        (preferred to https://fhir.interweavedigital.nhs.uk/R4/ValueSet/Interweave-SDSJobRoleName)
        Must Supporttrue
        110. PractitionerRole.code:SDSJobRoleName.coding
        112. PractitionerRole.code:SDSJobRoleName.coding.system
        Control1..?
        Fixed Valuehttps://fhir.interweavedigital.nhs.uk/CodeSystem/Interweave-SDSJobRoleName
        114. PractitionerRole.code:SDSJobRoleName.coding.code
        Control1..?
        116. PractitionerRole.code:SDSJobRoleName.coding.display
        Control1..?
        118. PractitionerRole.specialty
        BindingThe codes SHALL be taken from UK Core Practice Setting Code
        (required to https://fhir.hl7.org.uk/ValueSet/UKCore-PracticeSettingCode)
        120. PractitionerRole.specialty.id
        Control0..0
        122. PractitionerRole.specialty.extension
        Control0..0
        124. PractitionerRole.specialty.coding
        126. PractitionerRole.specialty.coding.system
        Control1..?
        128. PractitionerRole.specialty.coding.code
        Control1..?
        130. PractitionerRole.specialty.coding.display
        Control1..?
        132. PractitionerRole.location
        TypeReference(InterweaveLocation)
        134. PractitionerRole.location.id
        Control0..0
        136. PractitionerRole.location.extension
        Control0..0
        138. PractitionerRole.location.reference
        ShortReference to a resource (could be Contained)
        Control1..?
        140. PractitionerRole.location.type
        Control0..0
        142. PractitionerRole.location.identifier
        ShortIf relevant could include an id
        NoteThis is a business identifier, not a resource identifier (see discussion)
        144. PractitionerRole.location.display
        ShortIf relevant, description of the referenced resource
        146. PractitionerRole.healthcareService
        Control0..0
        148. PractitionerRole.availableTime
        Control0..0
        150. PractitionerRole.notAvailable
        Control0..0
        152. PractitionerRole.availabilityExceptions
        Control0..0
        154. PractitionerRole.endpoint
        Control0..0

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

        0. PractitionerRole
        Definition

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

        ShortRoles/organizations the practitioner is associated with
        Control0..*
        Is Modifierfalse
        Summaryfalse
        Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
        dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty())
        dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())
        dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
        dom-6: A resource should have narrative for robust management (text.`div`.exists())
        2. PractitionerRole.id
        Definition

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

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

        Control0..1
        Typeidstring
        Is Modifierfalse
        Must Supporttrue
        Summarytrue
        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.

        ShortMetadata about the resource
        Control0..1
        TypeMeta
        Is Modifierfalse
        Summarytrue
        Invariantsele-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.

        ShortUnique id for inter-element referencing
        Control0..01
        Typestring
        Is Modifierfalse
        XML FormatIn the XML format, this property is represented as an attribute.
        Summaryfalse
        8. 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.

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

        Control0..1
        Typeid
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Must Supporttrue
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        10. PractitionerRole.meta.lastUpdated
        Definition

        When the resource last changed - e.g. when the version changed.

        ShortMANDATORY except in Contained Resources. When the resource version last changed.When the resource version last changed
        Comments

        This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a read interaction.

        Control0..1
        Typeinstant
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Must Supporttrue
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        12. 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.

        ShortProfiles this resource claims to conform to. Should list (i) this profile (ii) base profile for this resource.
        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.

        Control0..*
        Typecanonical(StructureDefinition)
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Must Supporttrue
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        14. PractitionerRole.meta.security
        Definition

        Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.

        ShortDISCOURAGED - may not be honoured by Data ConsumersSecurity 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.

        Control0..*
        BindingUnless not suitable, these codes SHALL be taken from All Security Labelshttp://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.

        TypeCoding
        Is Modifierfalse
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        16. 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.

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

        Control0..*
        BindingFor example codes, see CommonTagshttp://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".

        TypeCoding
        Is Modifierfalse
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        SlicingThis element introduces a set of slices on PractitionerRole.meta.tag. The slices areUnordered and Open, and can be differentiated using the following discriminators:
        • value @ system
        • 18. PractitionerRole.meta.tag:Source
          Slice NameSource
          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.

          ShortMANDATORY except in Contained Resources. The Data Provider Id (and display text) of the system supplying the dataTags 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.

          Control0..1*
          BindingFor example codes, see CommonTagshttp://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".

          TypeCoding
          Is Modifierfalse
          Must Supporttrue
          Summarytrue
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          20. PractitionerRole.meta.tag:Source.id
          Definition

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

          ShortUnique id for inter-element referencing
          Control0..01
          Typestring
          Is Modifierfalse
          XML FormatIn the XML format, this property is represented as an attribute.
          Summaryfalse
          22. PractitionerRole.meta.tag:Source.system
          Definition

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

          ShortIdentity of the terminology 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.

          Control10..1
          Typeuri
          Is Modifierfalse
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Summarytrue
          Requirements

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

          Fixed Valuehttps://fhir.interweavedigital.nhs.uk/Source
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          24. PractitionerRole.meta.tag:Source.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.

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

          NoteThis is a business version Id, not a resource version Id (see discussion)
          Control0..01
          Typestring
          Is Modifierfalse
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Summarytrue
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          26. PractitionerRole.meta.tag:Source.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).

          ShortThe Data Provider Id of the system supplying the dataSymbol in syntax defined by the system
          Control10..1
          Typecode
          Is Modifierfalse
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Must Supporttrue
          Summarytrue
          Requirements

          Need to refer to a particular code in the system.

          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          28. PractitionerRole.meta.tag:Source.display
          Definition

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

          ShortName of the system supplying the dataRepresentation defined by the system
          Control10..1
          Typestring
          Is Modifierfalse
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Must Supporttrue
          Summarytrue
          Requirements

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

          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          30. PractitionerRole.meta.tag:Provenance
          Slice NameProvenance
          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.

          ShortMANDATORY except in Contained Resources. The ODS Code (and display text) of the organisation responsible for the dataTags 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.

          Control0..1*
          BindingFor example codes, see CommonTagshttp://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".

          TypeCoding
          Is Modifierfalse
          Must Supporttrue
          Summarytrue
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          32. PractitionerRole.meta.tag:Provenance.id
          Definition

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

          ShortUnique id for inter-element referencing
          Control0..01
          Typestring
          Is Modifierfalse
          XML FormatIn the XML format, this property is represented as an attribute.
          Summaryfalse
          34. PractitionerRole.meta.tag:Provenance.system
          Definition

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

          ShortIdentity of the terminology 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.

          Control10..1
          Typeuri
          Is Modifierfalse
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Summarytrue
          Requirements

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

          Fixed Valuehttps://fhir.interweavedigital.nhs.uk/Provenance
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          36. PractitionerRole.meta.tag:Provenance.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.

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

          NoteThis is a business version Id, not a resource version Id (see discussion)
          Control0..01
          Typestring
          Is Modifierfalse
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Summarytrue
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          38. PractitionerRole.meta.tag:Provenance.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).

          ShortThe ODS Code of the organisation responsible for the dataSymbol in syntax defined by the system
          Control10..1
          Typecode
          Is Modifierfalse
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Must Supporttrue
          Summarytrue
          Requirements

          Need to refer to a particular code in the system.

          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          40. PractitionerRole.meta.tag:Provenance.display
          Definition

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

          ShortName of the organisation supplying the dataRepresentation defined by the system
          Control10..1
          Typestring
          Is Modifierfalse
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Must Supporttrue
          Summarytrue
          Requirements

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

          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          42. 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.

          ShortDISCOURAGED - may not be honoured by Data ConsumersA 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.

          Control0..1
          Typeuri
          Is Modifiertrue 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 ValueThis primitive element may be present, or absent, or replaced by an extension
          Summarytrue
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          44. PractitionerRole.language
          Definition

          The base language in which the resource is written.

          ShortEnglish is assumed (not currently a multi-lingual implementation)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).

          Control0..1
          BindingThe codes SHOULD be taken from CommonLanguageshttp://hl7.org/fhir/ValueSet/languages
          (preferred to http://hl7.org/fhir/ValueSet/languages)

          A human language.

          Additional BindingsPurpose
          AllLanguagesMax Binding
          Typecode
          Is Modifierfalse
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Summaryfalse
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          46. 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.

          ShortDISCOURAGED - the preferred approach is to offer structured data fields which a Data Consumer can then render and present in a manner most suited to its usersText 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.

          Control0..1
          TypeNarrative
          Is Modifierfalse
          Summaryfalse
          Alternate Namesnarrative, html, xhtml, display
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          48. 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.

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

          Control0..*
          TypeExtension
          Is Modifierfalse
          Summaryfalse
          Alternate Namesextensions, user content
          Invariantsele-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())
          SlicingThis element introduces a set of slices on PractitionerRole.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
          • value @ url
          • 50. PractitionerRole.extension:serviceType
            Slice NameserviceType
            Definition

            Broad categorization of the service that is to be provided (e.g. cardiology).

            ShortThe services which the practitioner can offer.
            Control0..*
            This element is affected by the following invariants: ele-1
            TypeExtension(ExtensionInterweaveServiceType) (Extension Type: CodeableConcept)
            Is Modifierfalse
            Must Supporttrue
            Invariantsele-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())
            52. PractitionerRole.modifierExtension
            Definition

            May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it 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).

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

            Control0..*
            TypeExtension
            Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
            Summaryfalse
            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 Namesextensions, user content
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
            54. PractitionerRole.identifier
            Definition

            Business Identifiers that are specific to a role/location.

            ShortBusiness Identifiers that are specific to a role/location
            NoteThis is a business identifier, not a resource identifier (see discussion)
            Control0..*
            TypeIdentifier
            Is Modifierfalse
            Summarytrue
            Requirements

            Often, specific identities are assigned for the agent.

            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            56. PractitionerRole.identifier.id
            Definition

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

            ShortUnique id for inter-element referencing
            Control0..01
            Typestring
            Is Modifierfalse
            XML FormatIn the XML format, this property is represented as an attribute.
            Summaryfalse
            58. PractitionerRole.identifier.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.

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

            Control0..0*
            TypeExtension
            Is Modifierfalse
            Summaryfalse
            Alternate Namesextensions, user content
            Invariantsele-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())
            SlicingThis 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
            • 60. PractitionerRole.identifier.use
              Definition

              The purpose of this identifier.

              Shortusual | official | temp | secondary | old (If known)
              Comments

              Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

              Control0..1
              BindingThe codes SHALL be taken from IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1
              (required to http://hl7.org/fhir/ValueSet/identifier-use|4.0.1)

              Identifies the purpose for this identifier, if known .

              Typecode
              Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summarytrue
              Requirements

              Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              62. PractitionerRole.identifier.system
              Definition

              Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

              ShortThe namespace for the identifier value
              Comments

              Identifier.system is always case sensitive.

              Control10..1
              Typeuri
              Is Modifierfalse
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Must Supporttrue
              Summarytrue
              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<br/><b>General</b>:http://www.acme.com/identifiers/patient
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              64. PractitionerRole.identifier.value
              Definition

              The portion of the identifier typically relevant to the user and which is unique within the context of the system.

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

              Control10..1
              Typestring
              Is Modifierfalse
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Must Supporttrue
              Summarytrue
              Example<br/><b>General</b>:123456
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              66. PractitionerRole.identifier.assigner
              Definition

              Organization that issued/manages the identifier.

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

              Control0..1
              TypeReference(InterweaveOrganization, Organization)
              Is Modifierfalse
              Summarytrue
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              68. PractitionerRole.active
              Definition

              Whether this practitioner role record is in active use.

              ShortWhether this practitioner's “role” record is in active use.Whether 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.

              Control10..1
              Typeboolean
              Is Modifierfalse
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Must Supporttrue
              Summarytrue
              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 MissingThis resource is generally assumed to be active if no value is provided for the active element
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              70. PractitionerRole.period
              Definition

              The period during which the person is authorized to act as a practitioner in these role(s) for the organization.

              ShortThe period during which the practitioner is authorized to perform in these role(s).
              Control0..1
              TypePeriod
              Is Modifierfalse
              Must Supporttrue
              Summarytrue
              Requirements

              Even after the agencies is revoked, the fact that it existed must still be recorded.

              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              72. PractitionerRole.practitioner
              Definition

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

              ShortThe practitioner that is able to provide the defined services for the organisation.Practitioner that is able to provide the defined services for the organization
              Control10..1
              TypeReference(InterweavePractitioner, Practitioner)
              Is Modifierfalse
              Must Supporttrue
              Summarytrue
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              74. PractitionerRole.practitioner.id
              Definition

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

              ShortUnique id for inter-element referencing
              Control0..01
              Typestring
              Is Modifierfalse
              XML FormatIn the XML format, this property is represented as an attribute.
              Summaryfalse
              76. PractitionerRole.practitioner.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.

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

              Control0..0*
              TypeExtension
              Is Modifierfalse
              Summaryfalse
              Alternate Namesextensions, user content
              Invariantsele-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())
              SlicingThis element introduces a set of slices on PractitionerRole.practitioner.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
              • value @ url
              • 78. PractitionerRole.practitioner.reference
                Definition

                A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

                ShortReference to a resource (could be Contained)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.

                Control10..1
                This element is affected by the following invariants: ref-1
                Typestring
                Is Modifierfalse
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                Summarytrue
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                80. PractitionerRole.practitioner.type
                Definition

                The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.

                The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).

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

                Control0..01
                BindingUnless not suitable, these codes SHALL be taken from ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types
                (extensible to http://hl7.org/fhir/ValueSet/resource-types)

                Aa resource (or, for logical models, the URI of the logical model).

                Typeuri
                Is Modifierfalse
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                Summarytrue
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                82. PractitionerRole.practitioner.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.

                ShortIf relevant could include an idLogical 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).

                NoteThis is a business identifier, not a resource identifier (see discussion)
                Control0..1
                TypeIdentifier
                Is Modifierfalse
                Summarytrue
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                84. PractitionerRole.practitioner.display
                Definition

                Plain text narrative that identifies the resource in addition to the resource reference.

                ShortDescription of the referenced resourceText 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.

                Control10..1
                Typestring
                Is Modifierfalse
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                Summarytrue
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                86. PractitionerRole.organization
                Definition

                The organization where the Practitioner performs the roles associated.

                ShortThe organization where the Practitioner performs the roles associated.Organization where the roles are available
                Control0..1
                TypeReference(InterweaveOrganization, Organization)
                Is Modifierfalse
                Must Supporttrue
                Summarytrue
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                88. PractitionerRole.organization.id
                Definition

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

                ShortUnique id for inter-element referencing
                Control0..01
                Typestring
                Is Modifierfalse
                XML FormatIn the XML format, this property is represented as an attribute.
                Summaryfalse
                90. PractitionerRole.organization.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.

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

                Control0..0*
                TypeExtension
                Is Modifierfalse
                Summaryfalse
                Alternate Namesextensions, user content
                Invariantsele-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())
                SlicingThis element introduces a set of slices on PractitionerRole.organization.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                • value @ url
                • 92. PractitionerRole.organization.reference
                  Definition

                  A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

                  ShortReference to a resource (could be Contained)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.

                  Control10..1
                  This element is affected by the following invariants: ref-1
                  Typestring
                  Is Modifierfalse
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Summarytrue
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  94. PractitionerRole.organization.type
                  Definition

                  The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.

                  The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).

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

                  Control0..01
                  BindingUnless not suitable, these codes SHALL be taken from ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types
                  (extensible to http://hl7.org/fhir/ValueSet/resource-types)

                  Aa resource (or, for logical models, the URI of the logical model).

                  Typeuri
                  Is Modifierfalse
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Summarytrue
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  96. PractitionerRole.organization.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.

                  ShortIf relevant could include an idLogical 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).

                  NoteThis is a business identifier, not a resource identifier (see discussion)
                  Control0..1
                  TypeIdentifier
                  Is Modifierfalse
                  Summarytrue
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  98. PractitionerRole.organization.display
                  Definition

                  Plain text narrative that identifies the resource in addition to the resource reference.

                  ShortDescription of the referenced resourceText 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.

                  Control10..1
                  Typestring
                  Is Modifierfalse
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Summarytrue
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  100. PractitionerRole.code
                  Definition

                  Roles which this practitioner is authorized to perform for the organization.

                  ShortRoles which this practitioner may perform
                  Comments

                  A person may have more than one role.

                  Control10..*
                  BindingThe codes SHOULD be taken from For example codes, see PractitionerRolehttp://hl7.org/fhir/ValueSet/practitioner-role
                  (preferred to http://hl7.org/fhir/ValueSet/practitioner-role)
                  TypeCodeableConcept
                  Is Modifierfalse
                  Must Supporttrue
                  Summarytrue
                  Requirements

                  Need to know what authority the practitioner has - what can they do?

                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  SlicingThis element introduces a set of slices on PractitionerRole.code. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                  • value @ coding.system
                  • 102. PractitionerRole.code:SDSJobRoleName
                    Slice NameSDSJobRoleName
                    Definition

                    Roles which this practitioner is authorized to perform for the organization.

                    ShortRoles which this practitioner may perform
                    Comments

                    A person may have more than one role.

                    Control0..1*
                    BindingThe codes SHOULD be taken from For example codes, see InterweaveSDSJobRoleNamehttp://hl7.org/fhir/ValueSet/practitioner-role
                    (preferred to https://fhir.interweavedigital.nhs.uk/R4/ValueSet/Interweave-SDSJobRoleName)
                    TypeCodeableConcept
                    Is Modifierfalse
                    Must Supporttrue
                    Summarytrue
                    Requirements

                    Need to know what authority the practitioner has - what can they do?

                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    104. PractitionerRole.specialty
                    Definition

                    Specific specialty of the practitioner.

                    ShortSpecific specialty of the practitioner.
                    Control0..*
                    BindingThe codes SHALL be taken from The codes SHOULD be taken from UK Core Practice Setting Codehttp://hl7.org/fhir/ValueSet/c80-practice-codes
                    (required to https://fhir.hl7.org.uk/ValueSet/UKCore-PracticeSettingCode)
                    TypeCodeableConcept
                    Is Modifierfalse
                    Must Supporttrue
                    Summarytrue
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    106. PractitionerRole.specialty.id
                    Definition

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

                    ShortUnique id for inter-element referencing
                    Control0..01
                    Typestring
                    Is Modifierfalse
                    XML FormatIn the XML format, this property is represented as an attribute.
                    Summaryfalse
                    108. PractitionerRole.specialty.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.

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

                    Control0..0*
                    TypeExtension
                    Is Modifierfalse
                    Summaryfalse
                    Alternate Namesextensions, user content
                    Invariantsele-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())
                    SlicingThis element introduces a set of slices on PractitionerRole.specialty.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                    • value @ url
                    • 110. PractitionerRole.location
                      Definition

                      The location(s) at which this practitioner provides care.

                      ShortThe location(s) at which this practitioner provides care.
                      Control0..*
                      TypeReference(InterweaveLocation, Location)
                      Is Modifierfalse
                      Must Supporttrue
                      Summarytrue
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      112. PractitionerRole.location.id
                      Definition

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

                      ShortUnique id for inter-element referencing
                      Control0..01
                      Typestring
                      Is Modifierfalse
                      XML FormatIn the XML format, this property is represented as an attribute.
                      Summaryfalse
                      114. PractitionerRole.location.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.

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

                      Control0..0*
                      TypeExtension
                      Is Modifierfalse
                      Summaryfalse
                      Alternate Namesextensions, user content
                      Invariantsele-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())
                      SlicingThis element introduces a set of slices on PractitionerRole.location.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                      • value @ url
                      • 116. PractitionerRole.location.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.

                        ShortReference to a resource (could be Contained)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.

                        Control10..1
                        This element is affected by the following invariants: ref-1
                        Typestring
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Summarytrue
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        118. PractitionerRole.location.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).

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

                        Control0..01
                        BindingUnless not suitable, these codes SHALL be taken from ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types
                        (extensible to http://hl7.org/fhir/ValueSet/resource-types)

                        Aa resource (or, for logical models, the URI of the logical model).

                        Typeuri
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Summarytrue
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        120. PractitionerRole.location.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.

                        ShortIf relevant could include an idLogical 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).

                        NoteThis is a business identifier, not a resource identifier (see discussion)
                        Control0..1
                        TypeIdentifier
                        Is Modifierfalse
                        Summarytrue
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        122. PractitionerRole.location.display
                        Definition

                        Plain text narrative that identifies the resource in addition to the resource reference.

                        ShortIf relevant, description of the referenced resourceText 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.

                        Control0..1
                        Typestring
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Summarytrue
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        124. PractitionerRole.healthcareService
                        Definition

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

                        ShortThe list of healthcare services that this worker provides for this role's Organization/Location(s)
                        Control0..0*
                        TypeReference(HealthcareService)
                        Is Modifierfalse
                        Summaryfalse
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        126. PractitionerRole.telecom
                        Definition

                        Contact details that are specific to the role/location/service.

                        ShortContact details that are specific to the role/location/service.
                        Control0..*
                        TypeContactPoint
                        Is Modifierfalse
                        Must Supporttrue
                        Summarytrue
                        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.

                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        128. PractitionerRole.availableTime
                        Definition

                        A collection of times the practitioner is available or performing this role at the location and/or healthcareservice.

                        ShortTimes the Service Site is available
                        Comments

                        More detailed availability information may be provided in associated Schedule/Slot resources.

                        Control0..0*
                        TypeBackboneElement
                        Is Modifierfalse
                        Summaryfalse
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        131. PractitionerRole.notAvailable
                        Definition

                        The practitioner is not available or performing this role during this period of time due to the provided reason.

                        ShortNot available during this time due to provided reason
                        Control0..0*
                        TypeBackboneElement
                        Is Modifierfalse
                        Summaryfalse
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        135. 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.

                        ShortDescription of availability exceptions
                        Control0..01
                        Typestring
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Summaryfalse
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        137. PractitionerRole.endpoint
                        Definition

                        Technical endpoints providing access to services operated for the practitioner with this role.

                        ShortTechnical endpoints providing access to services operated for the practitioner with this role
                        Control0..0*
                        TypeReference(Endpoint)
                        Is Modifierfalse
                        Summaryfalse
                        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.

                        Invariantsele-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 found here

                        0. PractitionerRole
                        Definition

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

                        ShortRoles/organizations the practitioner is associated with
                        Control0..*
                        Is Modifierfalse
                        Summaryfalse
                        Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
                        dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty())
                        dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())
                        dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
                        dom-6: A resource should have narrative for robust management (text.`div`.exists())
                        2. PractitionerRole.id
                        Definition

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

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

                        Control0..1
                        Typeid
                        Is Modifierfalse
                        Must Supporttrue
                        Summarytrue
                        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.

                        ShortMetadata about the resource
                        Control0..1
                        TypeMeta
                        Is Modifierfalse
                        Summarytrue
                        Invariantsele-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.

                        ShortUnique id for inter-element referencing
                        Control0..0
                        Typestring
                        Is Modifierfalse
                        XML FormatIn the XML format, this property is represented as an attribute.
                        Summaryfalse
                        8. PractitionerRole.meta.extension
                        Definition

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

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

                        Control0..*
                        TypeExtension
                        Is Modifierfalse
                        Summaryfalse
                        Alternate Namesextensions, user content
                        Invariantsele-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())
                        SlicingThis 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.

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

                          Control0..1
                          Typeid
                          Is Modifierfalse
                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                          Must Supporttrue
                          Summarytrue
                          Invariantsele-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.

                          ShortMANDATORY except in Contained Resources. When the resource version last changed.
                          Comments

                          This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a read interaction.

                          Control0..1
                          Typeinstant
                          Is Modifierfalse
                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                          Must Supporttrue
                          Summarytrue
                          Invariantsele-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.

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

                          Control0..1
                          Typeuri
                          Is Modifierfalse
                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                          Summarytrue
                          Invariantsele-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.

                          ShortProfiles this resource claims to conform to. Should list (i) this profile (ii) base profile for this resource.
                          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.

                          Control0..*
                          Typecanonical(StructureDefinition)
                          Is Modifierfalse
                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                          Must Supporttrue
                          Summarytrue
                          Invariantsele-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.

                          ShortDISCOURAGED - may not be honoured by Data Consumers
                          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.

                          Control0..*
                          BindingUnless 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.

                          TypeCoding
                          Is Modifierfalse
                          Summarytrue
                          Invariantsele-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.

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

                          Control0..*
                          BindingFor 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".

                          TypeCoding
                          Is Modifierfalse
                          Summarytrue
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          SlicingThis element introduces a set of slices on PractitionerRole.meta.tag. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                          • value @ system
                          • 22. PractitionerRole.meta.tag:Source
                            Slice NameSource
                            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.

                            ShortMANDATORY except in Contained Resources. The Data Provider Id (and display text) of the system supplying the data
                            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.

                            Control0..1
                            BindingFor 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".

                            TypeCoding
                            Is Modifierfalse
                            Must Supporttrue
                            Summarytrue
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            24. PractitionerRole.meta.tag:Source.id
                            Definition

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

                            ShortUnique id for inter-element referencing
                            Control0..0
                            Typestring
                            Is Modifierfalse
                            XML FormatIn the XML format, this property is represented as an attribute.
                            Summaryfalse
                            26. PractitionerRole.meta.tag:Source.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.

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

                            Control0..*
                            TypeExtension
                            Is Modifierfalse
                            Summaryfalse
                            Alternate Namesextensions, user content
                            Invariantsele-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())
                            SlicingThis element introduces a set of slices on PractitionerRole.meta.tag.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                            • value @ url
                            • 28. PractitionerRole.meta.tag:Source.system
                              Definition

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

                              ShortIdentity of the terminology 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.

                              Control1..1
                              Typeuri
                              Is Modifierfalse
                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                              Summarytrue
                              Requirements

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

                              Fixed Valuehttps://fhir.interweavedigital.nhs.uk/Source
                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              30. PractitionerRole.meta.tag:Source.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.

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

                              NoteThis is a business version Id, not a resource version Id (see discussion)
                              Control0..0
                              Typestring
                              Is Modifierfalse
                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                              Summarytrue
                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              32. PractitionerRole.meta.tag:Source.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).

                              ShortThe Data Provider Id of the system supplying the data
                              Control1..1
                              Typecode
                              Is Modifierfalse
                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                              Must Supporttrue
                              Summarytrue
                              Requirements

                              Need to refer to a particular code in the system.

                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              34. PractitionerRole.meta.tag:Source.display
                              Definition

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

                              ShortName of the system supplying the data
                              Control1..1
                              Typestring
                              Is Modifierfalse
                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                              Must Supporttrue
                              Summarytrue
                              Requirements

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

                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              36. PractitionerRole.meta.tag:Source.userSelected
                              Definition

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

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

                              Control0..1
                              Typeboolean
                              Is Modifierfalse
                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                              Summarytrue
                              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.

                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              38. PractitionerRole.meta.tag:Provenance
                              Slice NameProvenance
                              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.

                              ShortMANDATORY except in Contained Resources. The ODS Code (and display text) of the organisation responsible for the data
                              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.

                              Control0..1
                              BindingFor 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".

                              TypeCoding
                              Is Modifierfalse
                              Must Supporttrue
                              Summarytrue
                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              40. PractitionerRole.meta.tag:Provenance.id
                              Definition

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

                              ShortUnique id for inter-element referencing
                              Control0..0
                              Typestring
                              Is Modifierfalse
                              XML FormatIn the XML format, this property is represented as an attribute.
                              Summaryfalse
                              42. PractitionerRole.meta.tag:Provenance.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.

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

                              Control0..*
                              TypeExtension
                              Is Modifierfalse
                              Summaryfalse
                              Alternate Namesextensions, user content
                              Invariantsele-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())
                              SlicingThis element introduces a set of slices on PractitionerRole.meta.tag.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                              • value @ url
                              • 44. PractitionerRole.meta.tag:Provenance.system
                                Definition

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

                                ShortIdentity of the terminology 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.

                                Control1..1
                                Typeuri
                                Is Modifierfalse
                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                Summarytrue
                                Requirements

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

                                Fixed Valuehttps://fhir.interweavedigital.nhs.uk/Provenance
                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                46. PractitionerRole.meta.tag:Provenance.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.

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

                                NoteThis is a business version Id, not a resource version Id (see discussion)
                                Control0..0
                                Typestring
                                Is Modifierfalse
                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                Summarytrue
                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                48. PractitionerRole.meta.tag:Provenance.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).

                                ShortThe ODS Code of the organisation responsible for the data
                                Control1..1
                                Typecode
                                Is Modifierfalse
                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                Must Supporttrue
                                Summarytrue
                                Requirements

                                Need to refer to a particular code in the system.

                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                50. PractitionerRole.meta.tag:Provenance.display
                                Definition

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

                                ShortName of the organisation supplying the data
                                Control1..1
                                Typestring
                                Is Modifierfalse
                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                Must Supporttrue
                                Summarytrue
                                Requirements

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

                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                52. PractitionerRole.meta.tag:Provenance.userSelected
                                Definition

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

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

                                Control0..1
                                Typeboolean
                                Is Modifierfalse
                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                Summarytrue
                                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.

                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                54. 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.

                                ShortDISCOURAGED - may not be honoured by Data Consumers
                                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.

                                Control0..1
                                Typeuri
                                Is Modifiertrue 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 ValueThis primitive element may be present, or absent, or replaced by an extension
                                Summarytrue
                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                56. PractitionerRole.language
                                Definition

                                The base language in which the resource is written.

                                ShortEnglish is assumed (not currently a multi-lingual implementation)
                                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).

                                Control0..1
                                BindingThe codes SHOULD be taken from CommonLanguages
                                (preferred to http://hl7.org/fhir/ValueSet/languages)

                                A human language.

                                Additional BindingsPurpose
                                AllLanguagesMax Binding
                                Typecode
                                Is Modifierfalse
                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                Summaryfalse
                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                58. 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.

                                ShortDISCOURAGED - the preferred approach is to offer structured data fields which a Data Consumer can then render and present in a manner most suited to its users
                                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.

                                Control0..1
                                TypeNarrative
                                Is Modifierfalse
                                Summaryfalse
                                Alternate Namesnarrative, html, xhtml, display
                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                60. 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.

                                ShortContained, 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.

                                Control0..*
                                TypeResource
                                Is Modifierfalse
                                Summaryfalse
                                Alternate Namesinline resources, anonymous resources, contained resources
                                62. PractitionerRole.extension
                                Definition

                                An Extension

                                ShortExtension
                                Control0..*
                                TypeExtension
                                Is Modifierfalse
                                Summaryfalse
                                Invariantsele-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())
                                SlicingThis element introduces a set of slices on PractitionerRole.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                • value @ url
                                • 64. PractitionerRole.extension:serviceType
                                  Slice NameserviceType
                                  Definition

                                  Broad categorization of the service that is to be provided (e.g. cardiology).

                                  ShortThe services which the practitioner can offer.
                                  Control0..*
                                  This element is affected by the following invariants: ele-1
                                  TypeExtension(ExtensionInterweaveServiceType) (Extension Type: CodeableConcept)
                                  Is Modifierfalse
                                  Must Supporttrue
                                  Invariantsele-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())
                                  66. PractitionerRole.modifierExtension
                                  Definition

                                  May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it 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).

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

                                  Control0..*
                                  TypeExtension
                                  Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
                                  Summaryfalse
                                  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 Namesextensions, user content
                                  Invariantsele-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())
                                  68. PractitionerRole.identifier
                                  Definition

                                  Business Identifiers that are specific to a role/location.

                                  ShortBusiness Identifiers that are specific to a role/location
                                  NoteThis is a business identifier, not a resource identifier (see discussion)
                                  Control0..*
                                  TypeIdentifier
                                  Is Modifierfalse
                                  Summarytrue
                                  Requirements

                                  Often, specific identities are assigned for the agent.

                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                  70. PractitionerRole.identifier.id
                                  Definition

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

                                  ShortUnique id for inter-element referencing
                                  Control0..0
                                  Typestring
                                  Is Modifierfalse
                                  XML FormatIn the XML format, this property is represented as an attribute.
                                  Summaryfalse
                                  72. PractitionerRole.identifier.extension
                                  Definition

                                  An Extension

                                  ShortExtension
                                  Control0..0
                                  TypeExtension
                                  Is Modifierfalse
                                  Summaryfalse
                                  Invariantsele-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())
                                  SlicingThis 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
                                  • 74. PractitionerRole.identifier.use
                                    Definition

                                    The purpose of this identifier.

                                    Shortusual | official | temp | secondary | old (If known)
                                    Comments

                                    Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

                                    Control0..1
                                    BindingThe codes SHALL be taken from IdentifierUse
                                    (required to http://hl7.org/fhir/ValueSet/identifier-use|4.0.1)

                                    Identifies the purpose for this identifier, if known .

                                    Typecode
                                    Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                    Summarytrue
                                    Requirements

                                    Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                    76. PractitionerRole.identifier.type
                                    Definition

                                    A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

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

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

                                    TypeCodeableConcept
                                    Is Modifierfalse
                                    Summarytrue
                                    Requirements

                                    Allows users to make use of identifiers when the identifier system is not known.

                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                    78. PractitionerRole.identifier.system
                                    Definition

                                    Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

                                    ShortThe namespace for the identifier value
                                    Comments

                                    Identifier.system is always case sensitive.

                                    Control1..1
                                    Typeuri
                                    Is Modifierfalse
                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                    Must Supporttrue
                                    Summarytrue
                                    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<br/><b>General</b>:http://www.acme.com/identifiers/patient
                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                    80. PractitionerRole.identifier.value
                                    Definition

                                    The portion of the identifier typically relevant to the user and which is unique within the context of the system.

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

                                    Control1..1
                                    Typestring
                                    Is Modifierfalse
                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                    Must Supporttrue
                                    Summarytrue
                                    Example<br/><b>General</b>:123456
                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                    82. PractitionerRole.identifier.period
                                    Definition

                                    Time period during which identifier is/was valid for use.

                                    ShortTime period when id is/was valid for use
                                    Control0..1
                                    TypePeriod
                                    Is Modifierfalse
                                    Summarytrue
                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                    84. PractitionerRole.identifier.assigner
                                    Definition

                                    Organization that issued/manages the identifier.

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

                                    Control0..1
                                    TypeReference(InterweaveOrganization)
                                    Is Modifierfalse
                                    Summarytrue
                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                    86. PractitionerRole.active
                                    Definition

                                    Whether this practitioner role record is in active use.

                                    ShortWhether this practitioner's “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.

                                    Control1..1
                                    Typeboolean
                                    Is Modifierfalse
                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                    Must Supporttrue
                                    Summarytrue
                                    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 MissingThis resource is generally assumed to be active if no value is provided for the active element
                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                    88. PractitionerRole.period
                                    Definition

                                    The period during which the person is authorized to act as a practitioner in these role(s) for the organization.

                                    ShortThe period during which the practitioner is authorized to perform in these role(s).
                                    Control0..1
                                    TypePeriod
                                    Is Modifierfalse
                                    Must Supporttrue
                                    Summarytrue
                                    Requirements

                                    Even after the agencies is revoked, the fact that it existed must still be recorded.

                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                    90. PractitionerRole.practitioner
                                    Definition

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

                                    ShortThe practitioner that is able to provide the defined services for the organisation.
                                    Control1..1
                                    TypeReference(InterweavePractitioner)
                                    Is Modifierfalse
                                    Must Supporttrue
                                    Summarytrue
                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                    92. PractitionerRole.practitioner.id
                                    Definition

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

                                    ShortUnique id for inter-element referencing
                                    Control0..0
                                    Typestring
                                    Is Modifierfalse
                                    XML FormatIn the XML format, this property is represented as an attribute.
                                    Summaryfalse
                                    94. PractitionerRole.practitioner.extension
                                    Definition

                                    An Extension

                                    ShortExtension
                                    Control0..0
                                    TypeExtension
                                    Is Modifierfalse
                                    Summaryfalse
                                    Invariantsele-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())
                                    SlicingThis element introduces a set of slices on PractitionerRole.practitioner.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                    • value @ url
                                    • 96. PractitionerRole.practitioner.reference
                                      Definition

                                      A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

                                      ShortReference to a resource (could be Contained)
                                      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.

                                      Control1..1
                                      This element is affected by the following invariants: ref-1
                                      Typestring
                                      Is Modifierfalse
                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                      Summarytrue
                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      98. PractitionerRole.practitioner.type
                                      Definition

                                      The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.

                                      The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).

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

                                      Control0..0
                                      BindingUnless 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).

                                      Typeuri
                                      Is Modifierfalse
                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                      Summarytrue
                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      100. PractitionerRole.practitioner.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.

                                      ShortIf relevant could include an id
                                      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).

                                      NoteThis is a business identifier, not a resource identifier (see discussion)
                                      Control0..1
                                      TypeIdentifier
                                      Is Modifierfalse
                                      Summarytrue
                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      102. PractitionerRole.practitioner.display
                                      Definition

                                      Plain text narrative that identifies the resource in addition to the resource reference.

                                      ShortDescription of the referenced 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.

                                      Control1..1
                                      Typestring
                                      Is Modifierfalse
                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                      Summarytrue
                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      104. PractitionerRole.organization
                                      Definition

                                      The organization where the Practitioner performs the roles associated.

                                      ShortThe organization where the Practitioner performs the roles associated.
                                      Control0..1
                                      TypeReference(InterweaveOrganization)
                                      Is Modifierfalse
                                      Must Supporttrue
                                      Summarytrue
                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                      106. PractitionerRole.organization.id
                                      Definition

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

                                      ShortUnique id for inter-element referencing
                                      Control0..0
                                      Typestring
                                      Is Modifierfalse
                                      XML FormatIn the XML format, this property is represented as an attribute.
                                      Summaryfalse
                                      108. PractitionerRole.organization.extension
                                      Definition

                                      An Extension

                                      ShortExtension
                                      Control0..0
                                      TypeExtension
                                      Is Modifierfalse
                                      Summaryfalse
                                      Invariantsele-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())
                                      SlicingThis element introduces a set of slices on PractitionerRole.organization.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                      • value @ url
                                      • 110. PractitionerRole.organization.reference
                                        Definition

                                        A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

                                        ShortReference to a resource (could be Contained)
                                        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.

                                        Control1..1
                                        This element is affected by the following invariants: ref-1
                                        Typestring
                                        Is Modifierfalse
                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                        Summarytrue
                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        112. PractitionerRole.organization.type
                                        Definition

                                        The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.

                                        The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).

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

                                        Control0..0
                                        BindingUnless 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).

                                        Typeuri
                                        Is Modifierfalse
                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                        Summarytrue
                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        114. PractitionerRole.organization.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.

                                        ShortIf relevant could include an id
                                        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).

                                        NoteThis is a business identifier, not a resource identifier (see discussion)
                                        Control0..1
                                        TypeIdentifier
                                        Is Modifierfalse
                                        Summarytrue
                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        116. PractitionerRole.organization.display
                                        Definition

                                        Plain text narrative that identifies the resource in addition to the resource reference.

                                        ShortDescription of the referenced 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.

                                        Control1..1
                                        Typestring
                                        Is Modifierfalse
                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                        Summarytrue
                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        118. PractitionerRole.code
                                        Definition

                                        Roles which this practitioner is authorized to perform for the organization.

                                        ShortRoles which this practitioner may perform
                                        Comments

                                        A person may have more than one role.

                                        Control1..*
                                        BindingThe codes SHOULD be taken from PractitionerRole
                                        (preferred to http://hl7.org/fhir/ValueSet/practitioner-role)
                                        TypeCodeableConcept
                                        Is Modifierfalse
                                        Must Supporttrue
                                        Summarytrue
                                        Requirements

                                        Need to know what authority the practitioner has - what can they do?

                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                        SlicingThis element introduces a set of slices on PractitionerRole.code. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                        • value @ coding.system
                                        • 120. PractitionerRole.code.id
                                          Definition

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

                                          ShortUnique id for inter-element referencing
                                          Control0..1
                                          Typestring
                                          Is Modifierfalse
                                          XML FormatIn the XML format, this property is represented as an attribute.
                                          Summaryfalse
                                          122. PractitionerRole.code.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.

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

                                          Control0..*
                                          TypeExtension
                                          Is Modifierfalse
                                          Summaryfalse
                                          Alternate Namesextensions, user content
                                          Invariantsele-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())
                                          SlicingThis element introduces a set of slices on PractitionerRole.code.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                          • value @ url
                                          • 124. PractitionerRole.code.coding
                                            Definition

                                            A reference to a code defined by a terminology system.

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

                                            Control0..*
                                            TypeCoding
                                            Is Modifierfalse
                                            Summarytrue
                                            Requirements

                                            Allows for alternative encodings within a code system, and translations to other code systems.

                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                            126. PractitionerRole.code.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.

                                            ShortUnique id for inter-element referencing
                                            Control0..0
                                            Typestring
                                            Is Modifierfalse
                                            XML FormatIn the XML format, this property is represented as an attribute.
                                            Summaryfalse
                                            128. PractitionerRole.code.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.

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

                                            Control0..*
                                            TypeExtension
                                            Is Modifierfalse
                                            Summaryfalse
                                            Alternate Namesextensions, user content
                                            Invariantsele-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())
                                            SlicingThis element introduces a set of slices on PractitionerRole.code.coding.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                            • value @ url
                                            • 130. PractitionerRole.code.coding.system
                                              Definition

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

                                              ShortIdentity of the terminology 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.

                                              Control1..1
                                              Typeuri
                                              Is Modifierfalse
                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                              Summarytrue
                                              Requirements

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

                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                              132. PractitionerRole.code.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.

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

                                              NoteThis is a business version Id, not a resource version Id (see discussion)
                                              Control0..0
                                              Typestring
                                              Is Modifierfalse
                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                              Summarytrue
                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                              134. PractitionerRole.code.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).

                                              ShortSymbol in syntax defined by the system
                                              Control1..1
                                              Typecode
                                              Is Modifierfalse
                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                              Summarytrue
                                              Requirements

                                              Need to refer to a particular code in the system.

                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                              136. PractitionerRole.code.coding.display
                                              Definition

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

                                              ShortRepresentation defined by the system
                                              Control1..1
                                              Typestring
                                              Is Modifierfalse
                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                              Summarytrue
                                              Requirements

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

                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                              138. PractitionerRole.code.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).

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

                                              Control0..1
                                              Typeboolean
                                              Is Modifierfalse
                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                              Summarytrue
                                              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.

                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                              140. PractitionerRole.code.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.

                                              ShortPlain text representation of the concept
                                              Comments

                                              Very often the text is the same as a displayName of one of the codings.

                                              Control0..1
                                              Typestring
                                              Is Modifierfalse
                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                              Summarytrue
                                              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.

                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                              142. PractitionerRole.code:SDSJobRoleName
                                              Slice NameSDSJobRoleName
                                              Definition

                                              Roles which this practitioner is authorized to perform for the organization.

                                              ShortRoles which this practitioner may perform
                                              Comments

                                              A person may have more than one role.

                                              Control0..1
                                              BindingThe codes SHOULD be taken from InterweaveSDSJobRoleName
                                              (preferred to https://fhir.interweavedigital.nhs.uk/R4/ValueSet/Interweave-SDSJobRoleName)
                                              TypeCodeableConcept
                                              Is Modifierfalse
                                              Must Supporttrue
                                              Summarytrue
                                              Requirements

                                              Need to know what authority the practitioner has - what can they do?

                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                              144. PractitionerRole.code:SDSJobRoleName.id
                                              Definition

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

                                              ShortUnique id for inter-element referencing
                                              Control0..1
                                              Typestring
                                              Is Modifierfalse
                                              XML FormatIn the XML format, this property is represented as an attribute.
                                              Summaryfalse
                                              146. PractitionerRole.code:SDSJobRoleName.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.

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

                                              Control0..*
                                              TypeExtension
                                              Is Modifierfalse
                                              Summaryfalse
                                              Alternate Namesextensions, user content
                                              Invariantsele-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())
                                              SlicingThis element introduces a set of slices on PractitionerRole.code.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                              • value @ url
                                              • 148. PractitionerRole.code:SDSJobRoleName.coding
                                                Definition

                                                A reference to a code defined by a terminology system.

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

                                                Control0..*
                                                TypeCoding
                                                Is Modifierfalse
                                                Summarytrue
                                                Requirements

                                                Allows for alternative encodings within a code system, and translations to other code systems.

                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                150. PractitionerRole.code:SDSJobRoleName.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.

                                                ShortUnique id for inter-element referencing
                                                Control0..1
                                                Typestring
                                                Is Modifierfalse
                                                XML FormatIn the XML format, this property is represented as an attribute.
                                                Summaryfalse
                                                152. PractitionerRole.code:SDSJobRoleName.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.

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

                                                Control0..*
                                                TypeExtension
                                                Is Modifierfalse
                                                Summaryfalse
                                                Alternate Namesextensions, user content
                                                Invariantsele-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())
                                                SlicingThis element introduces a set of slices on PractitionerRole.code.coding.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                • value @ url
                                                • 154. PractitionerRole.code:SDSJobRoleName.coding.system
                                                  Definition

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

                                                  ShortIdentity of the terminology 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.

                                                  Control1..1
                                                  Typeuri
                                                  Is Modifierfalse
                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                  Summarytrue
                                                  Requirements

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

                                                  Fixed Valuehttps://fhir.interweavedigital.nhs.uk/CodeSystem/Interweave-SDSJobRoleName
                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                  156. PractitionerRole.code:SDSJobRoleName.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.

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

                                                  NoteThis is a business version Id, not a resource version Id (see discussion)
                                                  Control0..1
                                                  Typestring
                                                  Is Modifierfalse
                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                  Summarytrue
                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                  158. PractitionerRole.code:SDSJobRoleName.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).

                                                  ShortSymbol in syntax defined by the system
                                                  Control1..1
                                                  Typecode
                                                  Is Modifierfalse
                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                  Summarytrue
                                                  Requirements

                                                  Need to refer to a particular code in the system.

                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                  160. PractitionerRole.code:SDSJobRoleName.coding.display
                                                  Definition

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

                                                  ShortRepresentation defined by the system
                                                  Control1..1
                                                  Typestring
                                                  Is Modifierfalse
                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                  Summarytrue
                                                  Requirements

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

                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                  162. PractitionerRole.code:SDSJobRoleName.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).

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

                                                  Control0..1
                                                  Typeboolean
                                                  Is Modifierfalse
                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                  Summarytrue
                                                  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.

                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                  164. PractitionerRole.code:SDSJobRoleName.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.

                                                  ShortPlain text representation of the concept
                                                  Comments

                                                  Very often the text is the same as a displayName of one of the codings.

                                                  Control0..1
                                                  Typestring
                                                  Is Modifierfalse
                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                  Summarytrue
                                                  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.

                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                  166. PractitionerRole.specialty
                                                  Definition

                                                  Specific specialty of the practitioner.

                                                  ShortSpecific specialty of the practitioner.
                                                  Control0..*
                                                  BindingThe codes SHALL be taken from UK Core Practice Setting Code
                                                  (required to https://fhir.hl7.org.uk/ValueSet/UKCore-PracticeSettingCode)
                                                  TypeCodeableConcept
                                                  Is Modifierfalse
                                                  Must Supporttrue
                                                  Summarytrue
                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                  168. PractitionerRole.specialty.id
                                                  Definition

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

                                                  ShortUnique id for inter-element referencing
                                                  Control0..0
                                                  Typestring
                                                  Is Modifierfalse
                                                  XML FormatIn the XML format, this property is represented as an attribute.
                                                  Summaryfalse
                                                  170. PractitionerRole.specialty.extension
                                                  Definition

                                                  An Extension

                                                  ShortExtension
                                                  Control0..0
                                                  TypeExtension
                                                  Is Modifierfalse
                                                  Summaryfalse
                                                  Invariantsele-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())
                                                  SlicingThis element introduces a set of slices on PractitionerRole.specialty.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                  • value @ url
                                                  • 172. PractitionerRole.specialty.coding
                                                    Definition

                                                    A reference to a code defined by a terminology system.

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

                                                    Control0..*
                                                    TypeCoding
                                                    Is Modifierfalse
                                                    Summarytrue
                                                    Requirements

                                                    Allows for alternative encodings within a code system, and translations to other code systems.

                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                    174. PractitionerRole.specialty.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.

                                                    ShortUnique id for inter-element referencing
                                                    Control0..1
                                                    Typestring
                                                    Is Modifierfalse
                                                    XML FormatIn the XML format, this property is represented as an attribute.
                                                    Summaryfalse
                                                    176. PractitionerRole.specialty.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.

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

                                                    Control0..*
                                                    TypeExtension
                                                    Is Modifierfalse
                                                    Summaryfalse
                                                    Alternate Namesextensions, user content
                                                    Invariantsele-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())
                                                    SlicingThis element introduces a set of slices on PractitionerRole.specialty.coding.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                    • value @ url
                                                    • 178. PractitionerRole.specialty.coding.system
                                                      Definition

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

                                                      ShortIdentity of the terminology 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.

                                                      Control1..1
                                                      Typeuri
                                                      Is Modifierfalse
                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                      Summarytrue
                                                      Requirements

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

                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                      180. PractitionerRole.specialty.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.

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

                                                      NoteThis is a business version Id, not a resource version Id (see discussion)
                                                      Control0..1
                                                      Typestring
                                                      Is Modifierfalse
                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                      Summarytrue
                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                      182. PractitionerRole.specialty.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).

                                                      ShortSymbol in syntax defined by the system
                                                      Control1..1
                                                      Typecode
                                                      Is Modifierfalse
                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                      Summarytrue
                                                      Requirements

                                                      Need to refer to a particular code in the system.

                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                      184. PractitionerRole.specialty.coding.display
                                                      Definition

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

                                                      ShortRepresentation defined by the system
                                                      Control1..1
                                                      Typestring
                                                      Is Modifierfalse
                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                      Summarytrue
                                                      Requirements

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

                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                      186. PractitionerRole.specialty.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).

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

                                                      Control0..1
                                                      Typeboolean
                                                      Is Modifierfalse
                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                      Summarytrue
                                                      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.

                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                      188. PractitionerRole.specialty.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.

                                                      ShortPlain text representation of the concept
                                                      Comments

                                                      Very often the text is the same as a displayName of one of the codings.

                                                      Control0..1
                                                      Typestring
                                                      Is Modifierfalse
                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                      Summarytrue
                                                      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.

                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                      190. PractitionerRole.location
                                                      Definition

                                                      The location(s) at which this practitioner provides care.

                                                      ShortThe location(s) at which this practitioner provides care.
                                                      Control0..*
                                                      TypeReference(InterweaveLocation)
                                                      Is Modifierfalse
                                                      Must Supporttrue
                                                      Summarytrue
                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                      192. PractitionerRole.location.id
                                                      Definition

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

                                                      ShortUnique id for inter-element referencing
                                                      Control0..0
                                                      Typestring
                                                      Is Modifierfalse
                                                      XML FormatIn the XML format, this property is represented as an attribute.
                                                      Summaryfalse
                                                      194. PractitionerRole.location.extension
                                                      Definition

                                                      An Extension

                                                      ShortExtension
                                                      Control0..0
                                                      TypeExtension
                                                      Is Modifierfalse
                                                      Summaryfalse
                                                      Invariantsele-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())
                                                      SlicingThis element introduces a set of slices on PractitionerRole.location.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                      • value @ url
                                                      • 196. PractitionerRole.location.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.

                                                        ShortReference to a resource (could be Contained)
                                                        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.

                                                        Control1..1
                                                        This element is affected by the following invariants: ref-1
                                                        Typestring
                                                        Is Modifierfalse
                                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                        Summarytrue
                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                        198. PractitionerRole.location.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).

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

                                                        Control0..0
                                                        BindingUnless 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).

                                                        Typeuri
                                                        Is Modifierfalse
                                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                        Summarytrue
                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                        200. PractitionerRole.location.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.

                                                        ShortIf relevant could include an id
                                                        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).

                                                        NoteThis is a business identifier, not a resource identifier (see discussion)
                                                        Control0..1
                                                        TypeIdentifier
                                                        Is Modifierfalse
                                                        Summarytrue
                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                        202. PractitionerRole.location.display
                                                        Definition

                                                        Plain text narrative that identifies the resource in addition to the resource reference.

                                                        ShortIf relevant, description of the referenced 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.

                                                        Control0..1
                                                        Typestring
                                                        Is Modifierfalse
                                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                        Summarytrue
                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                        204. PractitionerRole.healthcareService
                                                        Definition

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

                                                        ShortThe list of healthcare services that this worker provides for this role's Organization/Location(s)
                                                        Control0..0
                                                        TypeReference(HealthcareService)
                                                        Is Modifierfalse
                                                        Summaryfalse
                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                        206. PractitionerRole.telecom
                                                        Definition

                                                        Contact details that are specific to the role/location/service.

                                                        ShortContact details that are specific to the role/location/service.
                                                        Control0..*
                                                        TypeContactPoint
                                                        Is Modifierfalse
                                                        Must Supporttrue
                                                        Summarytrue
                                                        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.

                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                        208. PractitionerRole.availableTime
                                                        Definition

                                                        A collection of times the practitioner is available or performing this role at the location and/or healthcareservice.

                                                        ShortTimes the Service Site is available
                                                        Comments

                                                        More detailed availability information may be provided in associated Schedule/Slot resources.

                                                        Control0..0
                                                        TypeBackboneElement
                                                        Is Modifierfalse
                                                        Summaryfalse
                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                        217. PractitionerRole.notAvailable
                                                        Definition

                                                        The practitioner is not available or performing this role during this period of time due to the provided reason.

                                                        ShortNot available during this time due to provided reason
                                                        Control0..0
                                                        TypeBackboneElement
                                                        Is Modifierfalse
                                                        Summaryfalse
                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                        224. 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.

                                                        ShortDescription of availability exceptions
                                                        Control0..0
                                                        Typestring
                                                        Is Modifierfalse
                                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                        Summaryfalse
                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                        226. PractitionerRole.endpoint
                                                        Definition

                                                        Technical endpoints providing access to services operated for the practitioner with this role.

                                                        ShortTechnical endpoints providing access to services operated for the practitioner with this role
                                                        Control0..0
                                                        TypeReference(Endpoint)
                                                        Is Modifierfalse
                                                        Summaryfalse
                                                        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.

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