Vital Records Common Library (VRCL) STU2-ballot
2.0.0-ballot - ballot United States of America flag

This page is part of the Vital Records Common Profile Library (v2.0.0-ballot: STU 2 Ballot 1) based on FHIR (HL7® FHIR® Standard) R4. The current version which supersedes this version is 1.1.0. For a full list of available versions, see the Directory of published versions

Resource Profile: Practitioner - Vital Records

Official URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/Practitioner-vr Version: 2.0.0-ballot
Draft as of 2023-12-16 Computable Name: PractitionerVitalRecords

This Practitioner profile represents a practitioner who is involved in vital records (births, fetal death, death, etc.) as a certifier or an attendant. This profile is based on the US Core Practitioner and adds a further constraint to capture the title of the practitioner.

IJE Mapping

Natality
Use Case # Description IJE Name Field Type Value Set/Comments
Natality 124 Attendant Title ATTEND qualification.code codeable BirthAttendantTitlesVS
Natality 304 Attendant ("Other" specified text) ATTEND_OTH_TXT qualification.code.text string
Natality 326 Attendant's Name ATTEND_NAME name.text string
Natality 327 Attendant's NPI ATTEND_NPI identifier:NPI string
Natality 328 Certifier's Name CERTIF_NAME name.text string
Natality 329 Certifier's NPI CERTIF_NPI identifier:NPI identifier
Natality 330 Certifier Title CERTIF qualification.code codeable BirthAttendantTitlesVS
Natality 331 Certifier ("Other" specified text) CERTIF_OTH_TXT qualification.code.text string

Fetal Death
Use Case # Description IJE Name Field Type Value Set/Comments
Fetal Death 78 Attendant ATTEND qualification.code codeable BirthAttendantTitlesVS
Fetal Death 340 Attendant's Name ATTEND_NAME name.text string
Fetal Death 341 Attendant's NPI ATTEND_NPI identifier:NPI string
Fetal Death 342 Attendant ("Other" specified text) ATTEND_OTH_TXT qualification.code.text string code.text should contain description

Form Mapping

Item # Form Field FHIR Profile Field Reference
11 Certifier’s Name name Certificate of Live Birth
11 Certifier’s Title qualification Certificate of Live Birth
27 Attendant’s Name name Certificate of Live Birth
27 Attendant’s Title qualification Certificate of Live Birth
27 Attendant’s NPI identifier Certificate of Live Birth
19 Certifier’s name name Facility Worksheet for the Live Birth Certificate
19 Certifier’s title qualification Facility Worksheet for the Live Birth Certificate
24 Attendant’s name name Facility Worksheet for the Live Birth Certificate
24 Attendant’s title qualification Facility Worksheet for the Live Birth Certificate
24 Attendant’s N.P.I. identifier Facility Worksheet for the Live Birth Certificate
14 Attendant’s Name name Report of Fetal Death
14 Attendant’s Title qualification Report of Fetal Death
14 Attendant’s NPI identifier Report of Fetal Death
15 Name Of Person Completing Report name Report of Fetal Death
15 Title Of Person Completing Report qualification Report of Fetal Death
14 Name of person completing report name Facility Worksheet for the Report of Fetal Death
14 Title of person completing report qualification Facility Worksheet for the Report of Fetal Death
16 Attendant’s name name Facility Worksheet for the Report of Fetal Death
16 Attendant’s title qualification Facility Worksheet for the Report of Fetal Death
16 Attendant’s N.P.I. identifier Facility Worksheet for the Report of Fetal Death

Usage:

Formal Views of Profile Content

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

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
... name 1..1HumanNamename
... address 0..*Addressaddress
.... predir 0..1stringExtension - PreDirectional Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PreDirectional
.... stnum 0..1stringExtension - StreetNumber Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetNumber
.... stname 0..1stringExtension - StreetName Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetName
.... stdesig 0..1stringExtension - StreetDesignator Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetDesignator
.... postdir 0..1stringExtension - PostDirectional Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PostDirectional
.... unitnumber 0..1stringExtension - UnitOrAptNumber Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/UnitOrAptNumber
.... city 0..1stringcity
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... cityCode 0..1positiveIntCity Code
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/CityCode
.... district 0..1stringcounty
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... districtCode 0..1positiveIntCounty code
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/DistrictCode
.... state 0..1stringSub-unit of country (abbreviations ok)
Binding: ValueSet - States, Territories and Provinces Vital Records (required)
.... postalCode 0..1stringzip
.... country 0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
Binding: ValueSet - Residence Country Vital Records (required)
... Slices for qualification 0..1BackboneElementCertification, licenses, or training pertaining to the provision of care
Slice: Unordered, Open by value:code
.... qualification:birthAttendantQualification 0..1BackboneElementCertification, licenses, or training pertaining to the provision of care
..... code 1..1CodeableConceptList of titles
Binding: ValueSet - Birth Attendants Titles Vital Records (required): Live Birth/Fetal Death Practitioner title


doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Practitioner.address.staterequiredValueSetStatesTerritoriesAndProvincesVitalRecords
Practitioner.address.countryrequiredValueSetResidenceCountryVitalRecords
Practitioner.qualification:birthAttendantQualification.coderequiredValueSetBirthAttendantTitlesVitalRecords
NameFlagsCard.TypeDescription & Constraintsdoco
.. Practitioner 0..*USCorePractitionerProfileA person with a formal responsibility in the provisioning of healthcare or related services
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier SΣ1..*IdentifierAn identifier for the person as this agent
Slice: Unordered, Open by pattern:$this
.... identifier:All Slices Content/Rules for all slices
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... 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
.... identifier:NPI SΣ0..1IdentifierAn identifier for the person as this agent

Required Pattern: At least the following
..... system1..1uriThe namespace for the identifier value
Fixed Value: http://hl7.org/fhir/sid/us-npi
.... use ?!Σ0..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.

.... family SΣ1..1stringFamily name (often called 'Surname')
... telecom SΣ0..*ContactPointA contact detail for the practitioner (that apply to all roles)
.... system SΣC0..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

.... value SΣ0..1stringThe actual contact point details
.... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

... address SΣ0..*Addressaddress
.... predir 0..1stringExtension - PreDirectional Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PreDirectional
.... stnum 0..1stringExtension - StreetNumber Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetNumber
.... stname 0..1stringExtension - StreetName Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetName
.... stdesig 0..1stringExtension - StreetDesignator Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetDesignator
.... postdir 0..1stringExtension - PostDirectional Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PostDirectional
.... unitnumber 0..1stringExtension - UnitOrAptNumber Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/UnitOrAptNumber
.... use ?!Σ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
.... line SΣ0..4stringStreet 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 SΣ0..1stringcity
Example General: Erewhon
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... cityCode 0..1positiveIntCity Code
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/CityCode
.... district Σ0..1stringcounty
Example General: Madison
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... districtCode 0..1positiveIntCounty code
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/DistrictCode
.... state SΣ0..1stringSub-unit of country (abbreviations ok)
Binding: ValueSet - States, Territories and Provinces Vital Records (required)
.... postalCode SΣ0..1stringzip
Example General: 9132
.... country SΣ0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
Binding: ValueSet - Residence Country Vital Records (required)
... Slices for qualification 0..1BackboneElementCertification, licenses, or training pertaining to the provision of care
Slice: Unordered, Open by value:code
.... qualification:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code 1..1CodeableConceptCoded representation of the qualification
Binding: v2 table 0360, Version 2.7 (example): Specific qualification the practitioner has to provide a service.

.... qualification:birthAttendantQualification 0..1BackboneElementCertification, licenses, or training pertaining to the provision of care
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code 1..1CodeableConceptList of titles
Binding: ValueSet - Birth Attendants Titles Vital Records (required): Live Birth/Fetal Death Practitioner title


doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Practitioner.identifier.userequiredIdentifierUse
Practitioner.name.userequiredNameUse
Practitioner.telecom.systemrequiredContactPointSystem
Practitioner.telecom.userequiredContactPointUse
Practitioner.address.userequiredAddressUse
Practitioner.address.staterequiredValueSetStatesTerritoriesAndProvincesVitalRecords
Practitioner.address.countryrequiredValueSetResidenceCountryVitalRecords
Practitioner.qualification.codeexamplev2.0360.2.7 (a valid code from http://terminology.hl7.org/CodeSystem/v2-0360|2.7)
Practitioner.qualification:birthAttendantQualification.coderequiredValueSetBirthAttendantTitlesVitalRecords
NameFlagsCard.TypeDescription & Constraintsdoco
.. Practitioner 0..*USCorePractitionerProfileA 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
... 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
... Slices for identifier SΣ1..*IdentifierAn 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 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

..... 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:NPI SΣ0..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)
... active Σ0..1booleanWhether this practitioner's record is in active use
... name SΣ1..1HumanNamename
.... 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): The use of a human name.

.... 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 SΣ0..*ContactPointA contact detail for the practitioner (that apply to all roles)
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... system SΣC0..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

.... value SΣ0..1stringThe actual contact point details
.... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

.... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
.... period Σ0..1PeriodTime period when the contact point was/is in use
... address SΣ0..*Addressaddress
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... predir 0..1stringExtension - PreDirectional Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PreDirectional
.... stnum 0..1stringExtension - StreetNumber Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetNumber
.... stname 0..1stringExtension - StreetName Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetName
.... stdesig 0..1stringExtension - StreetDesignator Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetDesignator
.... postdir 0..1stringExtension - PostDirectional Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PostDirectional
.... unitnumber 0..1stringExtension - UnitOrAptNumber Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/UnitOrAptNumber
.... use ?!Σ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
.... type Σ0..1codepostal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).


Example General: both
.... text Σ0..1stringText representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
.... line SΣ0..4stringStreet 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 SΣ0..1stringcity
Example General: Erewhon
..... id 0..1stringxml:id (or equivalent in JSON)
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... cityCode 0..1positiveIntCity Code
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/CityCode
..... value 0..1stringPrimitive value for string
Max Length: 1048576
.... district Σ0..1stringcounty
Example General: Madison
..... id 0..1stringxml:id (or equivalent in JSON)
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... districtCode 0..1positiveIntCounty code
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/DistrictCode
..... value 0..1stringPrimitive value for string
Max Length: 1048576
.... state SΣ0..1stringSub-unit of country (abbreviations ok)
Binding: ValueSet - States, Territories and Provinces Vital Records (required)
.... postalCode SΣ0..1stringzip
Example General: 9132
.... country SΣ0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
Binding: ValueSet - Residence Country Vital Records (required)
.... period Σ0..1PeriodTime period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... gender Σ0..1codemale | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

... birthDate Σ0..1dateThe date on which the practitioner was born
... photo 0..*AttachmentImage of the person
... Slices for qualification 0..1BackboneElementCertification, licenses, or training pertaining to the provision of care
Slice: Unordered, Open by value:code
.... qualification:All Slices Content/Rules for all slices
..... 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): Specific qualification the practitioner has to provide a service.

..... period 0..1PeriodPeriod during which the qualification is valid
..... issuer 0..1Reference(Organization)Organization that regulates and issues the qualification
.... qualification:birthAttendantQualification 0..1BackboneElementCertification, 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..1CodeableConceptList of titles
Binding: ValueSet - Birth Attendants Titles Vital Records (required): Live Birth/Fetal Death Practitioner title

..... 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): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding


doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Practitioner.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Practitioner.identifier.userequiredIdentifierUse
Practitioner.identifier.typeextensibleIdentifier Type Codes
Practitioner.name.userequiredNameUse
Practitioner.telecom.systemrequiredContactPointSystem
Practitioner.telecom.userequiredContactPointUse
Practitioner.address.userequiredAddressUse
Practitioner.address.typerequiredAddressType
Practitioner.address.staterequiredValueSetStatesTerritoriesAndProvincesVitalRecords
Practitioner.address.countryrequiredValueSetResidenceCountryVitalRecords
Practitioner.genderrequiredAdministrativeGender
Practitioner.qualification.codeexamplev2.0360.2.7 (a valid code from http://terminology.hl7.org/CodeSystem/v2-0360|2.7)
Practitioner.qualification:birthAttendantQualification.coderequiredValueSetBirthAttendantTitlesVitalRecords
Practitioner.communicationpreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding

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
... name 1..1HumanNamename
... address 0..*Addressaddress
.... predir 0..1stringExtension - PreDirectional Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PreDirectional
.... stnum 0..1stringExtension - StreetNumber Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetNumber
.... stname 0..1stringExtension - StreetName Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetName
.... stdesig 0..1stringExtension - StreetDesignator Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetDesignator
.... postdir 0..1stringExtension - PostDirectional Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PostDirectional
.... unitnumber 0..1stringExtension - UnitOrAptNumber Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/UnitOrAptNumber
.... city 0..1stringcity
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... cityCode 0..1positiveIntCity Code
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/CityCode
.... district 0..1stringcounty
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... districtCode 0..1positiveIntCounty code
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/DistrictCode
.... state 0..1stringSub-unit of country (abbreviations ok)
Binding: ValueSet - States, Territories and Provinces Vital Records (required)
.... postalCode 0..1stringzip
.... country 0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
Binding: ValueSet - Residence Country Vital Records (required)
... Slices for qualification 0..1BackboneElementCertification, licenses, or training pertaining to the provision of care
Slice: Unordered, Open by value:code
.... qualification:birthAttendantQualification 0..1BackboneElementCertification, licenses, or training pertaining to the provision of care
..... code 1..1CodeableConceptList of titles
Binding: ValueSet - Birth Attendants Titles Vital Records (required): Live Birth/Fetal Death Practitioner title


doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
Practitioner.address.staterequiredValueSetStatesTerritoriesAndProvincesVitalRecords
Practitioner.address.countryrequiredValueSetResidenceCountryVitalRecords
Practitioner.qualification:birthAttendantQualification.coderequiredValueSetBirthAttendantTitlesVitalRecords

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Practitioner 0..*USCorePractitionerProfileA person with a formal responsibility in the provisioning of healthcare or related services
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier SΣ1..*IdentifierAn identifier for the person as this agent
Slice: Unordered, Open by pattern:$this
.... identifier:All Slices Content/Rules for all slices
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... 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
.... identifier:NPI SΣ0..1IdentifierAn identifier for the person as this agent

Required Pattern: At least the following
..... system1..1uriThe namespace for the identifier value
Fixed Value: http://hl7.org/fhir/sid/us-npi
.... use ?!Σ0..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.

.... family SΣ1..1stringFamily name (often called 'Surname')
... telecom SΣ0..*ContactPointA contact detail for the practitioner (that apply to all roles)
.... system SΣC0..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

.... value SΣ0..1stringThe actual contact point details
.... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

... address SΣ0..*Addressaddress
.... predir 0..1stringExtension - PreDirectional Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PreDirectional
.... stnum 0..1stringExtension - StreetNumber Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetNumber
.... stname 0..1stringExtension - StreetName Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetName
.... stdesig 0..1stringExtension - StreetDesignator Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetDesignator
.... postdir 0..1stringExtension - PostDirectional Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PostDirectional
.... unitnumber 0..1stringExtension - UnitOrAptNumber Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/UnitOrAptNumber
.... use ?!Σ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
.... line SΣ0..4stringStreet 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 SΣ0..1stringcity
Example General: Erewhon
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... cityCode 0..1positiveIntCity Code
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/CityCode
.... district Σ0..1stringcounty
Example General: Madison
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... districtCode 0..1positiveIntCounty code
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/DistrictCode
.... state SΣ0..1stringSub-unit of country (abbreviations ok)
Binding: ValueSet - States, Territories and Provinces Vital Records (required)
.... postalCode SΣ0..1stringzip
Example General: 9132
.... country SΣ0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
Binding: ValueSet - Residence Country Vital Records (required)
... Slices for qualification 0..1BackboneElementCertification, licenses, or training pertaining to the provision of care
Slice: Unordered, Open by value:code
.... qualification:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code 1..1CodeableConceptCoded representation of the qualification
Binding: v2 table 0360, Version 2.7 (example): Specific qualification the practitioner has to provide a service.

.... qualification:birthAttendantQualification 0..1BackboneElementCertification, licenses, or training pertaining to the provision of care
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code 1..1CodeableConceptList of titles
Binding: ValueSet - Birth Attendants Titles Vital Records (required): Live Birth/Fetal Death Practitioner title


doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Practitioner.identifier.userequiredIdentifierUse
Practitioner.name.userequiredNameUse
Practitioner.telecom.systemrequiredContactPointSystem
Practitioner.telecom.userequiredContactPointUse
Practitioner.address.userequiredAddressUse
Practitioner.address.staterequiredValueSetStatesTerritoriesAndProvincesVitalRecords
Practitioner.address.countryrequiredValueSetResidenceCountryVitalRecords
Practitioner.qualification.codeexamplev2.0360.2.7 (a valid code from http://terminology.hl7.org/CodeSystem/v2-0360|2.7)
Practitioner.qualification:birthAttendantQualification.coderequiredValueSetBirthAttendantTitlesVitalRecords

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Practitioner 0..*USCorePractitionerProfileA 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
... 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
... Slices for identifier SΣ1..*IdentifierAn 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 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

..... 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:NPI SΣ0..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)
... active Σ0..1booleanWhether this practitioner's record is in active use
... name SΣ1..1HumanNamename
.... 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): The use of a human name.

.... 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 SΣ0..*ContactPointA contact detail for the practitioner (that apply to all roles)
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... system SΣC0..1codephone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

.... value SΣ0..1stringThe actual contact point details
.... use ?!Σ0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

.... rank Σ0..1positiveIntSpecify preferred order of use (1 = highest)
.... period Σ0..1PeriodTime period when the contact point was/is in use
... address SΣ0..*Addressaddress
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... predir 0..1stringExtension - PreDirectional Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PreDirectional
.... stnum 0..1stringExtension - StreetNumber Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetNumber
.... stname 0..1stringExtension - StreetName Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetName
.... stdesig 0..1stringExtension - StreetDesignator Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/StreetDesignator
.... postdir 0..1stringExtension - PostDirectional Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/PostDirectional
.... unitnumber 0..1stringExtension - UnitOrAptNumber Vital Records
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/UnitOrAptNumber
.... use ?!Σ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
.... type Σ0..1codepostal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).


Example General: both
.... text Σ0..1stringText representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
.... line SΣ0..4stringStreet 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 SΣ0..1stringcity
Example General: Erewhon
..... id 0..1stringxml:id (or equivalent in JSON)
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... cityCode 0..1positiveIntCity Code
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/CityCode
..... value 0..1stringPrimitive value for string
Max Length: 1048576
.... district Σ0..1stringcounty
Example General: Madison
..... id 0..1stringxml:id (or equivalent in JSON)
..... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... districtCode 0..1positiveIntCounty code
URL: http://hl7.org/fhir/us/vr-common-library/StructureDefinition/DistrictCode
..... value 0..1stringPrimitive value for string
Max Length: 1048576
.... state SΣ0..1stringSub-unit of country (abbreviations ok)
Binding: ValueSet - States, Territories and Provinces Vital Records (required)
.... postalCode SΣ0..1stringzip
Example General: 9132
.... country SΣ0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
Binding: ValueSet - Residence Country Vital Records (required)
.... period Σ0..1PeriodTime period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... gender Σ0..1codemale | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

... birthDate Σ0..1dateThe date on which the practitioner was born
... photo 0..*AttachmentImage of the person
... Slices for qualification 0..1BackboneElementCertification, licenses, or training pertaining to the provision of care
Slice: Unordered, Open by value:code
.... qualification:All Slices Content/Rules for all slices
..... 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): Specific qualification the practitioner has to provide a service.

..... period 0..1PeriodPeriod during which the qualification is valid
..... issuer 0..1Reference(Organization)Organization that regulates and issues the qualification
.... qualification:birthAttendantQualification 0..1BackboneElementCertification, 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..1CodeableConceptList of titles
Binding: ValueSet - Birth Attendants Titles Vital Records (required): Live Birth/Fetal Death Practitioner title

..... 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): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding


doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Practitioner.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Practitioner.identifier.userequiredIdentifierUse
Practitioner.identifier.typeextensibleIdentifier Type Codes
Practitioner.name.userequiredNameUse
Practitioner.telecom.systemrequiredContactPointSystem
Practitioner.telecom.userequiredContactPointUse
Practitioner.address.userequiredAddressUse
Practitioner.address.typerequiredAddressType
Practitioner.address.staterequiredValueSetStatesTerritoriesAndProvincesVitalRecords
Practitioner.address.countryrequiredValueSetResidenceCountryVitalRecords
Practitioner.genderrequiredAdministrativeGender
Practitioner.qualification.codeexamplev2.0360.2.7 (a valid code from http://terminology.hl7.org/CodeSystem/v2-0360|2.7)
Practitioner.qualification:birthAttendantQualification.coderequiredValueSetBirthAttendantTitlesVitalRecords
Practitioner.communicationpreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding

 

Other representations of profile: CSV, Excel, Schematron