Current Build

​ D.4.1 StructureDefinition: practitioner

​D.4.1.1 Formal Views of Profile Content

The official URL for this profile is: 

http://hl7.org/fhir/hspc/StructureDefinition/practitioner

This profile builds on US Core Practitioner Profile.

This profile was published on Wed May 10 00:00:00 CDT 2017 as a draft by Healthcare Services Platform Consortium.

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

This structure is derived from US Core Practitioner Profile

Summary

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

This structure is derived from US Core Practitioner Profile

NameFlagsCard.TypeDescription & Constraintsdoco
.. Practitioner HSPC Provider/Practitioner
... identifier S1..*Identifier
.... system S1..1uriNPI could be used as the identifier system in the US.
.... value S1..1string
... name S1..1HumanName
.... family S1..1string
... telecom
.... Extension 0..*base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference(), SampledData, Signature, Timing, MetaOptional Extensions Element
URL: http://hl7.org/fhir/StructureDefinition/Extension
... address
.... Extension 0..*base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference(), SampledData, Signature, Timing, MetaOptional Extensions Element
URL: http://hl7.org/fhir/StructureDefinition/Extension
Binding: v2 Yes/no Indicator (preferred)
... qualification
.... Extension 0..*base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference(), SampledData, Signature, Timing, MetaOptional Extensions Element
URL: http://hl7.org/fhir/StructureDefinition/Extension
Binding: v2 Yes/no Indicator (preferred)
... communication
.... Extension 0..*base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference(), SampledData, Signature, Timing, MetaOptional Extensions Element
URL: http://hl7.org/fhir/StructureDefinition/Extension
Binding: Communication Mode (preferred)

doco Documentation for this format

This structure is derived from US Core Practitioner Profile

NameFlagsCard.TypeDescription & Constraintsdoco
.. Practitioner I0..*HSPC Practitioner
... 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: Common Languages (extensible)
Max Binding: All Languages
... text I0..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..*IdentifierA identifier for the person as this agent
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
.... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
.... system SΣ1..1uriNPI could be used as the identifier system in the US.
.... 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)
... active Σ0..1booleanWhether this practitioner's record is in active use
... name SΣ1..1HumanNameThe name(s) associated with the practitioner
.... id 0..1stringxml:id (or equivalent in JSON)
.... 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)
.... id 0..1stringxml:id (or equivalent in JSON)
.... Extension I0..*base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference(), SampledData, Signature, Timing, MetaExtension
URL: http://hl7.org/fhir/StructureDefinition/Extension
ext-1: Must have either extensions or value[x], not both
.... system ΣI0..1codephone | fax | email | pager | other
Binding: ContactPointSystem (required)
.... value Σ0..1stringThe actual contact point details
.... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
.... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
.... period Σ0..1PeriodTime period when the contact point was/is in use
... address Σ0..*AddressAddress(es) of the practitioner that are not role specific (typically home address)
.... id 0..1stringxml:id (or equivalent in JSON)
.... Extension I0..*base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference(), SampledData, Signature, Timing, MetaExtension
URL: http://hl7.org/fhir/StructureDefinition/Extension
Binding: v2 Yes/no Indicator (preferred)
ext-1: Must have either extensions or value[x], not both
.... use ?!Σ0..1codehome | work | temp | old - purpose of this address
Binding: AddressUse (required)
.... type Σ0..1codepostal | physical | both
Binding: AddressType (required)
.... text Σ0..1stringText representation of the address
.... line Σ0..*stringStreet name, number, direction, and P.O. Box etc.
.... city Σ0..1stringName of city, town etc.
.... district Σ0..1stringDistrict name (aka county)
.... state Σ0..1stringSub-unit of country (abbreviations ok)
.... postalCode Σ0..1stringPostal code for area
.... country Σ0..1stringCountry (can be ISO 3166 3 letter code)
.... period Σ0..1PeriodTime period when address was/is in use
... 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..*BackboneElementQualifications obtained by training and certification
.... id 0..1stringxml:id (or equivalent in JSON)
.... Extension I0..*base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference(), SampledData, Signature, Timing, MetaExtension
URL: http://hl7.org/fhir/StructureDefinition/Extension
Binding: v2 Yes/no Indicator (preferred)
ext-1: Must have either extensions or value[x], not both
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... 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 is able to use in patient communication
Binding: Common Languages (extensible)
Max Binding: All Languages
.... id 0..1stringxml:id (or equivalent in JSON)
.... Extension I0..*base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference(), SampledData, Signature, Timing, MetaExtension
URL: http://hl7.org/fhir/StructureDefinition/Extension
Binding: Communication Mode (preferred)
ext-1: Must have either extensions or value[x], not both
.... coding Σ0..*CodingCode defined by a terminology system
.... text Σ0..1stringPlain text representation of the concept

doco Documentation for this format

This structure is derived from US Core Practitioner Profile

Summary

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

Differential View

This structure is derived from US Core Practitioner Profile

NameFlagsCard.TypeDescription & Constraintsdoco
.. Practitioner HSPC Provider/Practitioner
... identifier S1..*Identifier
.... system S1..1uriNPI could be used as the identifier system in the US.
.... value S1..1string
... name S1..1HumanName
.... family S1..1string
... telecom
.... Extension 0..*base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference(), SampledData, Signature, Timing, MetaOptional Extensions Element
URL: http://hl7.org/fhir/StructureDefinition/Extension
... address
.... Extension 0..*base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference(), SampledData, Signature, Timing, MetaOptional Extensions Element
URL: http://hl7.org/fhir/StructureDefinition/Extension
Binding: v2 Yes/no Indicator (preferred)
... qualification
.... Extension 0..*base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference(), SampledData, Signature, Timing, MetaOptional Extensions Element
URL: http://hl7.org/fhir/StructureDefinition/Extension
Binding: v2 Yes/no Indicator (preferred)
... communication
.... Extension 0..*base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference(), SampledData, Signature, Timing, MetaOptional Extensions Element
URL: http://hl7.org/fhir/StructureDefinition/Extension
Binding: Communication Mode (preferred)

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Practitioner I0..*HSPC Practitioner
... 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: Common Languages (extensible)
Max Binding: All Languages
... text I0..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..*IdentifierA identifier for the person as this agent
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
.... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
.... system SΣ1..1uriNPI could be used as the identifier system in the US.
.... 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)
... active Σ0..1booleanWhether this practitioner's record is in active use
... name SΣ1..1HumanNameThe name(s) associated with the practitioner
.... id 0..1stringxml:id (or equivalent in JSON)
.... 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)
.... id 0..1stringxml:id (or equivalent in JSON)
.... Extension I0..*base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference(), SampledData, Signature, Timing, MetaExtension
URL: http://hl7.org/fhir/StructureDefinition/Extension
ext-1: Must have either extensions or value[x], not both
.... system ΣI0..1codephone | fax | email | pager | other
Binding: ContactPointSystem (required)
.... value Σ0..1stringThe actual contact point details
.... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
.... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
.... period Σ0..1PeriodTime period when the contact point was/is in use
... address Σ0..*AddressAddress(es) of the practitioner that are not role specific (typically home address)
.... id 0..1stringxml:id (or equivalent in JSON)
.... Extension I0..*base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference(), SampledData, Signature, Timing, MetaExtension
URL: http://hl7.org/fhir/StructureDefinition/Extension
Binding: v2 Yes/no Indicator (preferred)
ext-1: Must have either extensions or value[x], not both
.... use ?!Σ0..1codehome | work | temp | old - purpose of this address
Binding: AddressUse (required)
.... type Σ0..1codepostal | physical | both
Binding: AddressType (required)
.... text Σ0..1stringText representation of the address
.... line Σ0..*stringStreet name, number, direction, and P.O. Box etc.
.... city Σ0..1stringName of city, town etc.
.... district Σ0..1stringDistrict name (aka county)
.... state Σ0..1stringSub-unit of country (abbreviations ok)
.... postalCode Σ0..1stringPostal code for area
.... country Σ0..1stringCountry (can be ISO 3166 3 letter code)
.... period Σ0..1PeriodTime period when address was/is in use
... 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..*BackboneElementQualifications obtained by training and certification
.... id 0..1stringxml:id (or equivalent in JSON)
.... Extension I0..*base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference(), SampledData, Signature, Timing, MetaExtension
URL: http://hl7.org/fhir/StructureDefinition/Extension
Binding: v2 Yes/no Indicator (preferred)
ext-1: Must have either extensions or value[x], not both
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... 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 is able to use in patient communication
Binding: Common Languages (extensible)
Max Binding: All Languages
.... id 0..1stringxml:id (or equivalent in JSON)
.... Extension I0..*base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference(), SampledData, Signature, Timing, MetaExtension
URL: http://hl7.org/fhir/StructureDefinition/Extension
Binding: Communication Mode (preferred)
ext-1: Must have either extensions or value[x], not both
.... coding Σ0..*CodingCode defined by a terminology system
.... text Σ0..1stringPlain text representation of the concept

doco Documentation for this format

 

​D.4.1.2 Terminology Bindings

​D.4.1.3 Constraints

Constraints

IdPathDetailsRequirements
dom-2PractitionerIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-1PractitionerIf the resource is contained in another resource, it SHALL NOT contain any narrative
: contained.text.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
: contained.where(('#'+id in %resource.descendants().reference).not()).empty()
ext-1Practitioner.telecom.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ext-1Practitioner.address.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Practitioner.qualificationAll FHIR elements must have a @value or children
: children().count() > id.count()
ext-1Practitioner.qualification.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ext-1Practitioner.communication.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
.