Vital Records Death Reporting (VRDR) FHIR Implementation Guide
2.2.0 - STU 2.2
Vital Records Death Reporting (VRDR) FHIR Implementation Guide
2.2.0 - STU 2.2
This page is part of the Vital Records Death Reporting FHIR Implementation Guide (v2.2.0: STU 2) based on FHIR R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions
| Official URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/vrdr-certifier | Version: 2.2.0 | |||
| Active as of 2023-10-17 | Computable Name: Certifier | |||
Certifier (USCorePractitioner)
Note: The Certifier profile is based on the US Core Practitioner which requires an identifier be included. The death record submission process does not require an identifier. As a result, death record submissions that are complete will be flagged as invalid by the FHIR validator, unless they include an identifier.
| # | Description | IJE Name | IJE only | Field | Type | Value Set |
|---|---|---|---|---|---|---|
| 220 | Certifier’s First Name | CERTFIRST | x | name.given , name.use = official | string | - |
| 221 | Certifier’s Middle Name | CERTMIDDLE | x | name.given , name.use = official | string | - |
| 222 | Certifier’s Last Name | CERTLAST | x | name.family , name.use = official | string | - |
| 223 | Certifier’s Suffix Name | CERTSUFFIX | x | name.suffix , name.use = official | string | - |
| 224 | Certifier - Street number | CERTSTNUM | x | address.extension[stnum] | string | - |
| 225 | Certifier - Pre Directional | CERTPREDIR | x | address.extension[predir] | string | - |
| 226 | Certifier - Street name | CERTSTRNAME | x | address.extension[stname] | string | - |
| 227 | Certifier - Street designator | CERTSTRDESIG | x | address.extension[stdesig] | string | - |
| 228 | Certifier - Post Directional | CERTPOSTDIR | x | address.extension[postdir] | string | - |
| 229 | Certifier - Unit or apt number | CERTUNITNUM | x | address.extension[unitnum] | string | - |
| 230 | Long string address for Certifier same as above but allows states to choose the way they capture information. | CERTADDRESS | x | address.line | string | - |
| 231 | Certifier - City or Town name | CERTCITYTEXT | x | address.city | string | - |
| 232 | State, U.S. Territory or Canadian Province of Certifier - code | CERTSTATECD | x | address.state | string | StatesTerritoriesProvincesVS |
| 233 | State, U.S. Territory or Canadian Province of Certifier - literal | CERTSTATE | x | address.state (expanded from 2 letter code) | string | See StateLiterals |
| 234 | Certifier - Zip | CERTZIP | x | address.postalCode | string | - |
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from USCorePractitionerProfile
| Path | Conformance | ValueSet |
| Practitioner.address.state | required | StatesTerritoriesAndProvincesVS |
| Practitioner.address.country | required | ResidenceCountryVS |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Practitioner | 0..* | USCorePractitionerProfile | A person with a formal responsibility in the provisioning of healthcare or related services | |
  implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
  Slices for identifier | SΣ | 1..* | Identifier | An identifier for the person as this agent Slice: Unordered, Open by pattern:$this |
   identifier:All Slices | Content/Rules for all slices | |||
  use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| system | SΣ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
 value | SΣ | 1..1 | string | The value that is unique Example General: 123456 |
  identifier:NPI | SΣ | 0..1 | Identifier | An identifier for the person as this agent Required Pattern: At least the following |
   system | 1..1 | uri | The namespace for the identifier value Fixed Value: http://hl7.org/fhir/sid/us-npi | |
 name | SΣ | 1..1 | HumanName | name |
| use | ?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. |
 family | SΣ | 1..1 | string | Family name (often called 'Surname') |
| telecom | SΣ | 0..* | ContactPoint | A contact detail for the practitioner (that apply to all roles) |
| system | SΣC | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. |
| value | SΣ | 0..1 | string | The actual contact point details |
| use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. |
 address | SΣ | 0..* | Address | address |
| predir | 0..1 | string | Extension URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/PreDirectional | |
| stnum | 0..1 | string | Extension URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/StreetNumber | |
| stname | 0..1 | string | Extension URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/StreetName | |
| stdesig | 0..1 | string | Extension URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/StreetDesignator | |
| postdir | 0..1 | string | Extension URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/PostDirectional | |
| unitnumber | 0..1 | string | Extension URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/UnitOrAptNumber | |
| use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home |
| line | SΣ | 0..4 | string | Street 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..1 | string | city Example General: Erewhon |
 Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| cityCode | 0..1 | positiveInt | City Code URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/CityCode | |
| district | Σ | 0..1 | string | county Example General: Madison |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| districtCode | 0..1 | positiveInt | County code URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/DistrictCode | |
| state | SΣ | 0..1 | string | Sub-unit of country (abbreviations ok) Binding: States, Territories and Provinces Value Set (required) |
| postalCode | SΣ | 0..1 | string | zip Example General: 9132 |
| country | SΣ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) Binding: Residence Country Value Set (required) |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Practitioner.identifier.use | required | IdentifierUse |
| Practitioner.name.use | required | NameUse |
| Practitioner.telecom.system | required | ContactPointSystem |
| Practitioner.telecom.use | required | ContactPointUse |
| Practitioner.address.use | required | AddressUse |
| Practitioner.address.state | required | StatesTerritoriesAndProvincesVS |
| Practitioner.address.country | required | ResidenceCountryVS |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Practitioner | 0..* | USCorePractitionerProfile | A person with a formal responsibility in the provisioning of healthcare or related services | |||||
| id | Σ | 0..1 | id | Logical id of this artifact | ||||
| meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| Slices for identifier | SΣ | 1..* | Identifier | An identifier for the person as this agent Slice: Unordered, Open by pattern:$this | ||||
| identifier:All Slices | Content/Rules for all slices | |||||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
| type | Σ | 0..1 | CodeableConcept | Description 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..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
| value | SΣ | 1..1 | string | The value that is unique Example General: 123456 | ||||
| period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
 assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| identifier:NPI | SΣ | 0..1 | Identifier | An identifier for the person as this agent Required Pattern: At least the following | ||||
 id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| use | 0..1 | code | usual | official | temp | secondary | old (If known) | |||||
| type | 0..1 | CodeableConcept | Description of identifier | |||||
| system | 1..1 | uri | The namespace for the identifier value Fixed Value: http://hl7.org/fhir/sid/us-npi | |||||
| value | 0..1 | string | The value that is unique | |||||
| period | 0..1 | Period | Time period when id is/was valid for use | |||||
| assigner | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | |||||
| active | Σ | 0..1 | boolean | Whether this practitioner's record is in active use | ||||
| name | SΣ | 1..1 | HumanName | name | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use | ?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. | ||||
| text | Σ | 0..1 | string | Text representation of the full name | ||||
| family | SΣ | 1..1 | string | Family name (often called 'Surname') | ||||
| given | Σ | 0..* | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name | ||||
| prefix | Σ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name | ||||
| suffix | Σ | 0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name | ||||
| period | Σ | 0..1 | Period | Time period when name was/is in use | ||||
| telecom | SΣ | 0..* | ContactPoint | A contact detail for the practitioner (that apply to all roles) | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system | SΣC | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. | ||||
| value | SΣ | 0..1 | string | The actual contact point details | ||||
| use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||
| rank | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
| period | Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
| address | SΣ | 0..* | Address | address | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| predir | 0..1 | string | Extension URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/PreDirectional | |||||
| stnum | 0..1 | string | Extension URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/StreetNumber | |||||
| stname | 0..1 | string | Extension URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/StreetName | |||||
| stdesig | 0..1 | string | Extension URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/StreetDesignator | |||||
| postdir | 0..1 | string | Extension URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/PostDirectional | |||||
| unitnumber | 0..1 | string | Extension URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/UnitOrAptNumber | |||||
| use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home | ||||
| type | Σ | 0..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both | ||||
| text | Σ | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132 | ||||
| line | SΣ | 0..4 | string | Street 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..1 | string | city Example General: Erewhon | ||||
| id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| cityCode | 0..1 | positiveInt | City Code URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/CityCode | |||||
| value | 0..1 | string | Primitive value for string Max Length: 1048576 | |||||
| district | Σ | 0..1 | string | county Example General: Madison | ||||
| id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| districtCode | 0..1 | positiveInt | County code URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/DistrictCode | |||||
| value | 0..1 | string | Primitive value for string Max Length: 1048576 | |||||
| state | SΣ | 0..1 | string | Sub-unit of country (abbreviations ok) Binding: States, Territories and Provinces Value Set (required) | ||||
| postalCode | SΣ | 0..1 | string | zip Example General: 9132 | ||||
| country | SΣ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) Binding: Residence Country Value Set (required) | ||||
| period | Σ | 0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"} | ||||
| gender | Σ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | ||||
| birthDate | Σ | 0..1 | date | The date on which the practitioner was born | ||||
| photo | 0..* | Attachment | Image of the person | |||||
| qualification | 0..* | BackboneElement | Certification, licenses, or training pertaining to the provision of care | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| identifier | 0..* | Identifier | An identifier for this qualification for the practitioner | |||||
| code | 1..1 | CodeableConcept | Coded representation of the qualification Binding: v2 table 0360, Version 2.7 (example): Specific qualification the practitioner has to provide a service. | |||||
| period | 0..1 | Period | Period during which the qualification is valid | |||||
| issuer | 0..1 | Reference(Organization) | Organization that regulates and issues the qualification | |||||
| communication | 0..* | CodeableConcept | A language the practitioner can use in patient communication Binding: CommonLanguages (preferred): A human language.
| |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | ||||
| Practitioner.language | preferred | CommonLanguages
| ||||
| Practitioner.identifier.use | required | IdentifierUse | ||||
| Practitioner.identifier.type | extensible | Identifier Type Codes | ||||
| Practitioner.name.use | required | NameUse | ||||
| Practitioner.telecom.system | required | ContactPointSystem | ||||
| Practitioner.telecom.use | required | ContactPointUse | ||||
| Practitioner.address.use | required | AddressUse | ||||
| Practitioner.address.type | required | AddressType | ||||
| Practitioner.address.state | required | StatesTerritoriesAndProvincesVS | ||||
| Practitioner.address.country | required | ResidenceCountryVS | ||||
| Practitioner.gender | required | AdministrativeGender | ||||
| Practitioner.qualification.code | example | v2.0360.2.7 (a valid code from http://terminology.hl7.org/CodeSystem/v2-0360|2.7) | ||||
| Practitioner.communication | preferred | CommonLanguages
|
This structure is derived from USCorePractitionerProfile
Summary
Extensions
This structure refers to these extensions:
Differential View
This structure is derived from USCorePractitionerProfile
| Path | Conformance | ValueSet |
| Practitioner.address.state | required | StatesTerritoriesAndProvincesVS |
| Practitioner.address.country | required | ResidenceCountryVS |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Practitioner | 0..* | USCorePractitionerProfile | A person with a formal responsibility in the provisioning of healthcare or related services | |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| Slices for identifier | SΣ | 1..* | Identifier | An identifier for the person as this agent Slice: Unordered, Open by pattern:$this |
| identifier:All Slices | Content/Rules for all slices | |||
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| system | SΣ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
| value | SΣ | 1..1 | string | The value that is unique Example General: 123456 |
| identifier:NPI | SΣ | 0..1 | Identifier | An identifier for the person as this agent Required Pattern: At least the following |
| system | 1..1 | uri | The namespace for the identifier value Fixed Value: http://hl7.org/fhir/sid/us-npi | |
| name | SΣ | 1..1 | HumanName | name |
| use | ?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. |
| family | SΣ | 1..1 | string | Family name (often called 'Surname') |
| telecom | SΣ | 0..* | ContactPoint | A contact detail for the practitioner (that apply to all roles) |
| system | SΣC | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. |
| value | SΣ | 0..1 | string | The actual contact point details |
| use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. |
| address | SΣ | 0..* | Address | address |
| predir | 0..1 | string | Extension URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/PreDirectional | |
| stnum | 0..1 | string | Extension URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/StreetNumber | |
| stname | 0..1 | string | Extension URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/StreetName | |
| stdesig | 0..1 | string | Extension URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/StreetDesignator | |
| postdir | 0..1 | string | Extension URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/PostDirectional | |
| unitnumber | 0..1 | string | Extension URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/UnitOrAptNumber | |
| use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home |
| line | SΣ | 0..4 | string | Street 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..1 | string | city Example General: Erewhon |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| cityCode | 0..1 | positiveInt | City Code URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/CityCode | |
| district | Σ | 0..1 | string | county Example General: Madison |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| districtCode | 0..1 | positiveInt | County code URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/DistrictCode | |
| state | SΣ | 0..1 | string | Sub-unit of country (abbreviations ok) Binding: States, Territories and Provinces Value Set (required) |
| postalCode | SΣ | 0..1 | string | zip Example General: 9132 |
| country | SΣ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) Binding: Residence Country Value Set (required) |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Practitioner.identifier.use | required | IdentifierUse |
| Practitioner.name.use | required | NameUse |
| Practitioner.telecom.system | required | ContactPointSystem |
| Practitioner.telecom.use | required | ContactPointUse |
| Practitioner.address.use | required | AddressUse |
| Practitioner.address.state | required | StatesTerritoriesAndProvincesVS |
| Practitioner.address.country | required | ResidenceCountryVS |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Practitioner | 0..* | USCorePractitionerProfile | A person with a formal responsibility in the provisioning of healthcare or related services | |||||
| id | Σ | 0..1 | id | Logical id of this artifact | ||||
| meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| Slices for identifier | SΣ | 1..* | Identifier | An identifier for the person as this agent Slice: Unordered, Open by pattern:$this | ||||
| identifier:All Slices | Content/Rules for all slices | |||||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
| type | Σ | 0..1 | CodeableConcept | Description 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..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
| value | SΣ | 1..1 | string | The value that is unique Example General: 123456 | ||||
| period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| identifier:NPI | SΣ | 0..1 | Identifier | An identifier for the person as this agent Required Pattern: At least the following | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| use | 0..1 | code | usual | official | temp | secondary | old (If known) | |||||
| type | 0..1 | CodeableConcept | Description of identifier | |||||
| system | 1..1 | uri | The namespace for the identifier value Fixed Value: http://hl7.org/fhir/sid/us-npi | |||||
| value | 0..1 | string | The value that is unique | |||||
| period | 0..1 | Period | Time period when id is/was valid for use | |||||
| assigner | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | |||||
| active | Σ | 0..1 | boolean | Whether this practitioner's record is in active use | ||||
| name | SΣ | 1..1 | HumanName | name | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use | ?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. | ||||
| text | Σ | 0..1 | string | Text representation of the full name | ||||
| family | SΣ | 1..1 | string | Family name (often called 'Surname') | ||||
| given | Σ | 0..* | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name | ||||
| prefix | Σ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name | ||||
| suffix | Σ | 0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name | ||||
| period | Σ | 0..1 | Period | Time period when name was/is in use | ||||
| telecom | SΣ | 0..* | ContactPoint | A contact detail for the practitioner (that apply to all roles) | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system | SΣC | 0..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. | ||||
| value | SΣ | 0..1 | string | The actual contact point details | ||||
| use | ?!Σ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | ||||
| rank | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | ||||
| period | Σ | 0..1 | Period | Time period when the contact point was/is in use | ||||
| address | SΣ | 0..* | Address | address | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| predir | 0..1 | string | Extension URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/PreDirectional | |||||
| stnum | 0..1 | string | Extension URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/StreetNumber | |||||
| stname | 0..1 | string | Extension URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/StreetName | |||||
| stdesig | 0..1 | string | Extension URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/StreetDesignator | |||||
| postdir | 0..1 | string | Extension URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/PostDirectional | |||||
| unitnumber | 0..1 | string | Extension URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/UnitOrAptNumber | |||||
| use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home | ||||
| type | Σ | 0..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both | ||||
| text | Σ | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132 | ||||
| line | SΣ | 0..4 | string | Street 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..1 | string | city Example General: Erewhon | ||||
| id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| cityCode | 0..1 | positiveInt | City Code URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/CityCode | |||||
| value | 0..1 | string | Primitive value for string Max Length: 1048576 | |||||
| district | Σ | 0..1 | string | county Example General: Madison | ||||
| id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| districtCode | 0..1 | positiveInt | County code URL: http://hl7.org/fhir/us/vrdr/StructureDefinition/DistrictCode | |||||
| value | 0..1 | string | Primitive value for string Max Length: 1048576 | |||||
| state | SΣ | 0..1 | string | Sub-unit of country (abbreviations ok) Binding: States, Territories and Provinces Value Set (required) | ||||
| postalCode | SΣ | 0..1 | string | zip Example General: 9132 | ||||
| country | SΣ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) Binding: Residence Country Value Set (required) | ||||
| period | Σ | 0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"} | ||||
| gender | Σ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | ||||
| birthDate | Σ | 0..1 | date | The date on which the practitioner was born | ||||
| photo | 0..* | Attachment | Image of the person | |||||
| qualification | 0..* | BackboneElement | Certification, licenses, or training pertaining to the provision of care | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| identifier | 0..* | Identifier | An identifier for this qualification for the practitioner | |||||
| code | 1..1 | CodeableConcept | Coded representation of the qualification Binding: v2 table 0360, Version 2.7 (example): Specific qualification the practitioner has to provide a service. | |||||
| period | 0..1 | Period | Period during which the qualification is valid | |||||
| issuer | 0..1 | Reference(Organization) | Organization that regulates and issues the qualification | |||||
| communication | 0..* | CodeableConcept | A language the practitioner can use in patient communication Binding: CommonLanguages (preferred): A human language.
| |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | ||||
| Practitioner.language | preferred | CommonLanguages
| ||||
| Practitioner.identifier.use | required | IdentifierUse | ||||
| Practitioner.identifier.type | extensible | Identifier Type Codes | ||||
| Practitioner.name.use | required | NameUse | ||||
| Practitioner.telecom.system | required | ContactPointSystem | ||||
| Practitioner.telecom.use | required | ContactPointUse | ||||
| Practitioner.address.use | required | AddressUse | ||||
| Practitioner.address.type | required | AddressType | ||||
| Practitioner.address.state | required | StatesTerritoriesAndProvincesVS | ||||
| Practitioner.address.country | required | ResidenceCountryVS | ||||
| Practitioner.gender | required | AdministrativeGender | ||||
| Practitioner.qualification.code | example | v2.0360.2.7 (a valid code from http://terminology.hl7.org/CodeSystem/v2-0360|2.7) | ||||
| Practitioner.communication | preferred | CommonLanguages
|
This structure is derived from USCorePractitionerProfile
Summary
Extensions
This structure refers to these extensions:
Other representations of profile: CSV, Excel, Schematron
IG © 2022+ HL7 International / Public Health. Package hl7.fhir.us.vrdr#2.2.0 based on FHIR 4.0.1. Generated 2023-10-17
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change