Da Vinci Health Record Exchange (HRex)
0.2.0 - STU R1 - 2nd ballot

This page is part of the Da Vinci Health Record Exchange (v0.2.0: STU1 Ballot 1) based on FHIR R4. The current version which supercedes this version is 1.0.0. For a full list of available versions, see the Directory of published versions

Resource Profile: HRexPractitioner

Constraints on the US Core Practitioner profiles requiring support for qualification and requiring support for an additional identifier type

The official URL for this profile is:

http://hl7.org/fhir/us/davinci-hrex/StructureDefinition/hrex-practitioner

Da Vinci refines Practitioner in two ways:

  • It requires support for Practitioner qualifications, though only as text. (There is no consistent coding of qualifications in the payer space.) Qualifications can be important for evaluating the eligibility of ordered or performed services for insurance coverage.
  • It adds support for Medicare certification number as an alternate identifier type as not all payer and provider environments are able to use NPIs for all relevant providers.

Formal Views of Profile Content

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

This structure is derived from USCorePractitionerProfile

Summary

Mandatory: 0 element (2 nested mandatory elements)
Must-Support: 6 elements

This structure is derived from USCorePractitionerProfile

NameFlagsCard.TypeDescription & Constraintsdoco
.. Practitioner 0..*USCorePractitionerProfileA person with a formal responsibility in the provisioning of healthcare or related services
... identifier 1..*IdentifierAn identifier for the person as this agent
.... system S1..1uriThe namespace for the identifier value
.... value S1..1stringThe value that is unique
... identifier:ccn S0..1IdentifierAn identifier for the person as this agent
Required Pattern: At least the following
.... system1..1uriThe namespace for the identifier value
Fixed Value: http://todo/medicare-certification-number
... telecom
.... system 0..1codephone | fax | email | pager | url | sms | other
.... value 0..1stringThe actual contact point details
.... code S1..1CodeableConceptCoded representation of the qualification
..... text S1..1stringPlain text representation of the concept

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Practitioner I0..*USCorePractitionerProfileA person with a formal responsibility in the provisioning of healthcare or related services
... id Σ0..1stringLogical id of this artifact
... meta ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... identifier SΣI1..*(Slice Definition)An identifier for the person as this agent
Slice: Unordered, Open by pattern:$this
.... identifier:All Slices Content/Rules for all slices
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!ΣI0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
..... type ΣI0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
..... system SΣI1..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value SΣI1..1stringThe value that is unique
Example General: 123456
..... period ΣI0..1PeriodTime period when id is/was valid for use
..... assigner ΣI0..1Reference(Organization)Organization that issued id (may be just text)
.... identifier:NPI SΣI0..1IdentifierAn identifier for the person as this agent

Required Pattern: At least the following
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... use0..1codeusual | official | temp | secondary | old (If known)
..... type0..1CodeableConceptDescription of identifier
..... system1..1uriThe namespace for the identifier value
Fixed Value: http://hl7.org/fhir/sid/us-npi
..... value0..1stringThe value that is unique
..... period0..1PeriodTime period when id is/was valid for use
..... assigner0..1Reference(Organization)Organization that issued id (may be just text)
.... identifier:ccn SΣI0..1IdentifierAn identifier for the person as this agent

Required Pattern: At least the following
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... use0..1codeusual | official | temp | secondary | old (If known)
..... type0..1CodeableConceptDescription of identifier
..... system1..1uriThe namespace for the identifier value
Fixed Value: http://todo/medicare-certification-number
..... value0..1stringThe value that is unique
..... period0..1PeriodTime period when id is/was valid for use
..... assigner0..1Reference(Organization)Organization that issued id (may be just text)
... active ΣI0..1booleanWhether this practitioner's record is in active use
... name SΣI1..*HumanNameThe name(s) associated with the practitioner
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!ΣI0..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required)
.... text ΣI0..1stringText representation of the full name
.... family SΣI1..1stringFamily name (often called 'Surname')
.... given ΣI0..*stringGiven names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
.... prefix ΣI0..*stringParts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
.... suffix ΣI0..*stringParts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
.... period ΣI0..1PeriodTime period when name was/is in use
... telecom ΣI0..*ContactPointA contact detail for the practitioner (that apply to all roles)
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... system ΣI0..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
.... value ΣI0..1stringThe actual contact point details
.... use ?!ΣI0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
.... rank ΣI0..1positiveIntSpecify preferred order of use (1 = highest)
.... period ΣI0..1PeriodTime period when the contact point was/is in use
... address ΣI0..*AddressAddress(es) of the practitioner that are not role specific (typically home address)
... gender ΣI0..1codemale | female | other | unknown
Binding: AdministrativeGender (required)
... birthDate ΣI0..1dateThe date on which the practitioner was born
... photo I0..*AttachmentImage of the person
... qualification SI0..*BackboneElementCertification, licenses, or training pertaining to the provision of care
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... identifier I0..*IdentifierAn identifier for this qualification for the practitioner
.... code SI1..1CodeableConceptCoded representation of the qualification
Binding: v2 table 0360, Version 2.7 (example)
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... coding ΣI0..*CodingCode defined by a terminology system
..... text SΣI1..1stringPlain text representation of the concept
.... period I0..1PeriodPeriod during which the qualification is valid
.... issuer I0..1Reference(Organization)Organization that regulates and issues the qualification
... communication I0..*CodeableConceptA language the practitioner can use in patient communication
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Practitioner I0..*USCorePractitionerProfileA person with a formal responsibility in the provisioning of healthcare or related services
... identifier ΣI1..*(Slice Definition)An identifier for the person as this agent
Slice: Unordered, Open by pattern:$this
.... identifier:All Slices Content/Rules for all slices
..... system ΣI1..1uriThe namespace for the identifier value
..... value ΣI1..1stringThe value that is unique
.... identifier:NPI ΣI0..1IdentifierAn identifier for the person as this agent

Required Pattern: At least the following
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... use0..1codeusual | official | temp | secondary | old (If known)
..... type0..1CodeableConceptDescription of identifier
..... system1..1uriThe namespace for the identifier value
Fixed Value: http://hl7.org/fhir/sid/us-npi
..... value0..1stringThe value that is unique
..... period0..1PeriodTime period when id is/was valid for use
..... assigner0..1Reference(Organization)Organization that issued id (may be just text)
.... identifier:ccn ΣI0..1IdentifierAn identifier for the person as this agent

Required Pattern: At least the following
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... use0..1codeusual | official | temp | secondary | old (If known)
..... type0..1CodeableConceptDescription of identifier
..... system1..1uriThe namespace for the identifier value
Fixed Value: http://todo/medicare-certification-number
..... value0..1stringThe value that is unique
..... period0..1PeriodTime period when id is/was valid for use
..... assigner0..1Reference(Organization)Organization that issued id (may be just text)
... name ΣI1..*HumanNameThe name(s) associated with the practitioner
.... family ΣI1..1stringFamily name (often called 'Surname')
... qualification I0..*BackboneElementCertification, licenses, or training pertaining to the provision of care
.... code I1..1CodeableConceptCoded representation of the qualification
Binding: v2 table 0360, Version 2.7 (example)
..... text ΣI1..1stringPlain text representation of the concept

doco Documentation for this format

This structure is derived from USCorePractitionerProfile

Summary

Mandatory: 0 element (2 nested mandatory elements)
Must-Support: 6 elements

Differential View

This structure is derived from USCorePractitionerProfile

NameFlagsCard.TypeDescription & Constraintsdoco
.. Practitioner 0..*USCorePractitionerProfileA person with a formal responsibility in the provisioning of healthcare or related services
... identifier 1..*IdentifierAn identifier for the person as this agent
.... system S1..1uriThe namespace for the identifier value
.... value S1..1stringThe value that is unique
... identifier:ccn S0..1IdentifierAn identifier for the person as this agent
Required Pattern: At least the following
.... system1..1uriThe namespace for the identifier value
Fixed Value: http://todo/medicare-certification-number
... telecom
.... system 0..1codephone | fax | email | pager | url | sms | other
.... value 0..1stringThe actual contact point details
.... code S1..1CodeableConceptCoded representation of the qualification
..... text S1..1stringPlain text representation of the concept

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Practitioner I0..*USCorePractitionerProfileA person with a formal responsibility in the provisioning of healthcare or related services
... id Σ0..1stringLogical id of this artifact
... meta ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... identifier SΣI1..*(Slice Definition)An identifier for the person as this agent
Slice: Unordered, Open by pattern:$this
.... identifier:All Slices Content/Rules for all slices
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!ΣI0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
..... type ΣI0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
..... system SΣI1..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value SΣI1..1stringThe value that is unique
Example General: 123456
..... period ΣI0..1PeriodTime period when id is/was valid for use
..... assigner ΣI0..1Reference(Organization)Organization that issued id (may be just text)
.... identifier:NPI SΣI0..1IdentifierAn identifier for the person as this agent

Required Pattern: At least the following
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... use0..1codeusual | official | temp | secondary | old (If known)
..... type0..1CodeableConceptDescription of identifier
..... system1..1uriThe namespace for the identifier value
Fixed Value: http://hl7.org/fhir/sid/us-npi
..... value0..1stringThe value that is unique
..... period0..1PeriodTime period when id is/was valid for use
..... assigner0..1Reference(Organization)Organization that issued id (may be just text)
.... identifier:ccn SΣI0..1IdentifierAn identifier for the person as this agent

Required Pattern: At least the following
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... use0..1codeusual | official | temp | secondary | old (If known)
..... type0..1CodeableConceptDescription of identifier
..... system1..1uriThe namespace for the identifier value
Fixed Value: http://todo/medicare-certification-number
..... value0..1stringThe value that is unique
..... period0..1PeriodTime period when id is/was valid for use
..... assigner0..1Reference(Organization)Organization that issued id (may be just text)
... active ΣI0..1booleanWhether this practitioner's record is in active use
... name SΣI1..*HumanNameThe name(s) associated with the practitioner
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!ΣI0..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required)
.... text ΣI0..1stringText representation of the full name
.... family SΣI1..1stringFamily name (often called 'Surname')
.... given ΣI0..*stringGiven names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
.... prefix ΣI0..*stringParts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
.... suffix ΣI0..*stringParts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
.... period ΣI0..1PeriodTime period when name was/is in use
... telecom ΣI0..*ContactPointA contact detail for the practitioner (that apply to all roles)
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... system ΣI0..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required)
.... value ΣI0..1stringThe actual contact point details
.... use ?!ΣI0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
.... rank ΣI0..1positiveIntSpecify preferred order of use (1 = highest)
.... period ΣI0..1PeriodTime period when the contact point was/is in use
... address ΣI0..*AddressAddress(es) of the practitioner that are not role specific (typically home address)
... gender ΣI0..1codemale | female | other | unknown
Binding: AdministrativeGender (required)
... birthDate ΣI0..1dateThe date on which the practitioner was born
... photo I0..*AttachmentImage of the person
... qualification SI0..*BackboneElementCertification, licenses, or training pertaining to the provision of care
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... identifier I0..*IdentifierAn identifier for this qualification for the practitioner
.... code SI1..1CodeableConceptCoded representation of the qualification
Binding: v2 table 0360, Version 2.7 (example)
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... coding ΣI0..*CodingCode defined by a terminology system
..... text SΣI1..1stringPlain text representation of the concept
.... period I0..1PeriodPeriod during which the qualification is valid
.... issuer I0..1Reference(Organization)Organization that regulates and issues the qualification
... communication I0..*CodeableConceptA language the practitioner can use in patient communication
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages

doco Documentation for this format

 

Other representations of profile: Schematron

Terminology Bindings

PathConformanceValueSet
Practitioner.languagepreferredCommonLanguages
Max Binding: AllLanguages
Practitioner.identifier.userequiredIdentifierUse
Practitioner.identifier.typeextensibleIdentifier Type Codes
Practitioner.name.userequiredNameUse
Practitioner.telecom.systemrequiredContactPointSystem
Practitioner.telecom.userequiredContactPointUse
Practitioner.genderrequiredAdministrativeGender
Practitioner.qualification.codeexamplev2.0360.2.7
Practitioner.communicationpreferredCommonLanguages
Max Binding: AllLanguages

Constraints

IdPathDetailsRequirements
dom-2PractitionerIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3PractitionerIf 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-4PractitionerIf 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-5PractitionerIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6PractitionerA resource should have narrative for robust management
: text.`div`.exists()
ele-1Practitioner.metaAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Practitioner.implicitRulesAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Practitioner.languageAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Practitioner.textAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Practitioner.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Practitioner.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Practitioner.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Practitioner.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Practitioner.identifierAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Practitioner.identifier.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Practitioner.identifier.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Practitioner.identifier.useAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Practitioner.identifier.typeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Practitioner.identifier.systemAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Practitioner.identifier.valueAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Practitioner.identifier.periodAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Practitioner.identifier.assignerAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Practitioner.identifier:NPIAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Practitioner.identifier:ccnAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Practitioner.activeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Practitioner.nameAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Practitioner.name.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Practitioner.name.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Practitioner.name.useAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Practitioner.name.textAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Practitioner.name.familyAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Practitioner.name.givenAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Practitioner.name.prefixAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Practitioner.name.suffixAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Practitioner.name.periodAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Practitioner.telecomAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Practitioner.telecom.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Practitioner.telecom.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Practitioner.telecom.systemAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Practitioner.telecom.valueAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Practitioner.telecom.useAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Practitioner.telecom.rankAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Practitioner.telecom.periodAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Practitioner.addressAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Practitioner.genderAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Practitioner.birthDateAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Practitioner.photoAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Practitioner.qualificationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Practitioner.qualification.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Practitioner.qualification.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Practitioner.qualification.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Practitioner.qualification.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Practitioner.qualification.identifierAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Practitioner.qualification.codeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Practitioner.qualification.code.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Practitioner.qualification.code.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Practitioner.qualification.code.codingAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Practitioner.qualification.code.textAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Practitioner.qualification.periodAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Practitioner.qualification.issuerAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Practitioner.communicationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())