Da Vinci Health Record Exchange (HRex)
0.1.0 - CI Build

Da Vinci Health Record Exchange (HRex), published by HL7 International - Financial Management Work Group. This is not an authorized publication; it is the continuous build for version 0.1.0). This version is based on the current content of https://github.com/HL7/davinci-ehrx/ and changes regularly. See the Directory of published versions

Resource Profile: HRexPractitioner

HRexPractitioner requires an NPI and that qualification be supported.

The official URL for this profile is:

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

Formal Views of Profile Content

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

This structure is derived from USCorePractitionerProfile

Summary

Mandatory: 2 elements
Must-Support: 4 elements
Fixed Value: 1 element

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 S1..*IdentifierAn identifier for the person as this agent
... identifier:npislice S1..1IdentifierAn identifier for the person as this agent
.... system S1..1uriThe namespace for the identifier value
Fixed Value: http://hl7.org/fhir/sid/us-npi
... qualification S0..*BackboneElementCertification, licenses, or training pertaining to the provision of care
Binding: (unbound) (required)
.... code 1..1CodeableConceptCoded representation of the qualification
Binding: (unbound) (required)

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: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:npislice SΣI1..1IdentifierAn identifier for the person as this agent
..... 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
Fixed Value: http://hl7.org/fhir/sid/us-npi
..... value ΣI0..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)
... 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)
... 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 I1..1CodeableConceptCoded representation of the qualification
Binding: v2 table 0360, Version 2.7 (required)
.... 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

This structure is derived from USCorePractitionerProfile

Summary

Mandatory: 2 elements
Must-Support: 4 elements
Fixed Value: 1 element

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 S1..*IdentifierAn identifier for the person as this agent
... identifier:npislice S1..1IdentifierAn identifier for the person as this agent
.... system S1..1uriThe namespace for the identifier value
Fixed Value: http://hl7.org/fhir/sid/us-npi
... qualification S0..*BackboneElementCertification, licenses, or training pertaining to the provision of care
Binding: (unbound) (required)
.... code 1..1CodeableConceptCoded representation of the qualification
Binding: (unbound) (required)

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: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:npislice SΣI1..1IdentifierAn identifier for the person as this agent
..... 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
Fixed Value: http://hl7.org/fhir/sid/us-npi
..... value ΣI0..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)
... 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)
... 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 I1..1CodeableConceptCoded representation of the qualification
Binding: v2 table 0360, Version 2.7 (required)
.... 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:npislice.userequiredIdentifierUse
Practitioner.identifier:npislice.typeextensibleIdentifier Type Codes
Practitioner.name.userequiredNameUse
Practitioner.genderrequiredAdministrativeGender
Practitioner.qualification.coderequiredv2.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:NPIAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Practitioner.identifier:npisliceAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Practitioner.identifier:npislice.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Practitioner.identifier:npislice.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Practitioner.identifier:npislice.useAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Practitioner.identifier:npislice.typeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Practitioner.identifier:npislice.systemAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Practitioner.identifier:npislice.valueAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Practitioner.identifier:npislice.periodAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Practitioner.identifier:npislice.assignerAll 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.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.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())