Electronic Long-Term Services and Supports (eLTSS) Release 1 - US Realm

This page is part of the electronic Long-Term Services and Supports Implementation Guide (v1.0.0: STU 1) based on FHIR R4. This is the current published version in it's permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

StructureDefinition: Practitioner_eltss

The official URL for this profile is:

http://hl7.org/fhir/us/eltss/StructureDefinition/Practitioner-eltss

Formal Views of Profile Content

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

This structure is derived from USCorePractitionerProfile

Summary

Must-Support: 1 element

NameFlagsCard.TypeDescription & Constraintsdoco
.. Practitioner I0..*A person with a formal responsibility in the provisioning of healthcare or related services
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣ1..*(Slice Definition)An identifier for the person as this agent
Slice: Unordered, Open by value:system
.... identifier:All Slices Content/Rules for all slices
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
..... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
..... system SΣ1..1uriThe namespace for the identifier value
Example General': http://www.acme.com/identifiers/patient
..... value SΣ1..1stringThe value that is unique
Example General': 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
.... identifier:npislice SΣ0..1IdentifierAn identifier for the person as this agent
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
..... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
..... system SΣ1..1uriThe namespace for the identifier value
Fixed Value: http://hl7.org/fhir/sid/us-npi
..... value Σ0..1stringThe value that is unique
Example General': 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... active Σ0..1booleanWhether this practitioner's record is in active use
... name SΣ1..*HumanNameThe name(s) associated with the practitioner
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required)
.... text Σ0..1stringText representation of the full name
.... family SΣ1..1stringFamily name (often called 'Surname')
.... given Σ0..*stringGiven names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
.... prefix Σ0..*stringParts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
.... suffix Σ0..*stringParts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
.... period Σ0..1PeriodTime period when name was/is in use
... telecom Σ0..*ContactPointA contact detail for the practitioner (that apply to all roles)
... address Σ0..*AddressAddress(es) of the practitioner that are not role specific (typically home address)
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required)
Example General': home
.... type Σ0..1codepostal | physical | both
Binding: AddressType (required)
Example General': both
.... text Σ0..1stringText representation of the address
Example General': 137 Nowhere Street, Erewhon 9132
.... line Σ0..*stringStreet name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General': 137 Nowhere Street
.... city Σ0..1stringName of city, town etc.
Example General': Erewhon
.... district SΣ0..1stringCounty
Example General': Madison
.... state Σ0..1stringSub-unit of country (abbreviations ok)
.... postalCode Σ0..1stringPostal code for area
Example General': 9132
.... country Σ0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
.... period Σ0..1PeriodTime period when address was/is in use
Example General': {"start":"2010-03-23T00:00:00-04:00","end":"2010-07-01T00:00:00-04:00"}
... gender Σ0..1codemale | female | other | unknown
Binding: AdministrativeGender (required)
... birthDate Σ0..1dateThe date on which the practitioner was born
... photo 0..*AttachmentImage of the person
... qualification I0..*BackboneElementCertification, licenses, or training pertaining to the provision of care
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... identifier 0..*IdentifierAn identifier for this qualification for the practitioner
.... code 1..1CodeableConceptCoded representation of the qualification
Binding: v2 table 0360, Version 2.7 (example)
.... period 0..1PeriodPeriod during which the qualification is valid
.... issuer 0..1Reference(Organization)Organization that regulates and issues the qualification
... communication 0..*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

Must-Support: 1 element

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Practitioner I0..*A person with a formal responsibility in the provisioning of healthcare or related services
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣ1..*(Slice Definition)An identifier for the person as this agent
Slice: Unordered, Open by value:system
.... identifier:All Slices Content/Rules for all slices
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
..... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
..... system SΣ1..1uriThe namespace for the identifier value
Example General': http://www.acme.com/identifiers/patient
..... value SΣ1..1stringThe value that is unique
Example General': 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
.... identifier:npislice SΣ0..1IdentifierAn identifier for the person as this agent
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
..... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
..... system SΣ1..1uriThe namespace for the identifier value
Fixed Value: http://hl7.org/fhir/sid/us-npi
..... value Σ0..1stringThe value that is unique
Example General': 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... active Σ0..1booleanWhether this practitioner's record is in active use
... name SΣ1..*HumanNameThe name(s) associated with the practitioner
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required)
.... text Σ0..1stringText representation of the full name
.... family SΣ1..1stringFamily name (often called 'Surname')
.... given Σ0..*stringGiven names (not always 'first'). Includes middle names
This repeating element order: Given Names appear in the correct order for presenting the name
.... prefix Σ0..*stringParts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
.... suffix Σ0..*stringParts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
.... period Σ0..1PeriodTime period when name was/is in use
... telecom Σ0..*ContactPointA contact detail for the practitioner (that apply to all roles)
... address Σ0..*AddressAddress(es) of the practitioner that are not role specific (typically home address)
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required)
Example General': home
.... type Σ0..1codepostal | physical | both
Binding: AddressType (required)
Example General': both
.... text Σ0..1stringText representation of the address
Example General': 137 Nowhere Street, Erewhon 9132
.... line Σ0..*stringStreet name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General': 137 Nowhere Street
.... city Σ0..1stringName of city, town etc.
Example General': Erewhon
.... district SΣ0..1stringCounty
Example General': Madison
.... state Σ0..1stringSub-unit of country (abbreviations ok)
.... postalCode Σ0..1stringPostal code for area
Example General': 9132
.... country Σ0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
.... period Σ0..1PeriodTime period when address was/is in use
Example General': {"start":"2010-03-23T00:00:00-04:00","end":"2010-07-01T00:00:00-04:00"}
... gender Σ0..1codemale | female | other | unknown
Binding: AdministrativeGender (required)
... birthDate Σ0..1dateThe date on which the practitioner was born
... photo 0..*AttachmentImage of the person
... qualification I0..*BackboneElementCertification, licenses, or training pertaining to the provision of care
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... identifier 0..*IdentifierAn identifier for this qualification for the practitioner
.... code 1..1CodeableConceptCoded representation of the qualification
Binding: v2 table 0360, Version 2.7 (example)
.... period 0..1PeriodPeriod during which the qualification is valid
.... issuer 0..1Reference(Organization)Organization that regulates and issues the qualification
... communication 0..*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.identifier:npislice.userequiredIdentifierUse
Practitioner.identifier:npislice.typeextensibleIdentifier Type Codes
Practitioner.name.userequiredNameUse
Practitioner.address.userequiredAddressUse
Practitioner.address.typerequiredAddressType
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-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-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-6PractitionerA resource should have narrative for robust management
: text.div.exists()
dom-5PractitionerIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
ele-1Practitioner.qualificationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())