US Core Implementation Guide (Release 1)
This page is part of the US Core (v1.0.0: STU1) based on FHIR R3. The current version which supercedes this version is 5.0.1. For a full list of available versions, see the Directory of published versions 
This profile sets minimum expectations for the Practitioner resource to record [content] associated with a patient. It identifies which core elements, extensions, vocabularies and value sets SHALL be present in the resource when using this profile.
Example Usage Scenarios:
The following are example usage scenarios for the US Core-Practitioner profile:
The following data-elements are mandatory (i.e data MUST be present). These are presented below in a simple human-readable explanation. Profile specific guidance and examples are provided as well. The Formal Profile Definition below provides the formal summary, definitions, and terminology requirements.
Each Practitioner must have:
Profile specific implementation guidance:
The official URL for this profile is:
http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner
This profile builds on Practitioner.
This profile was published on Mon Aug 01 00:00:00 AEST 2016 as a draft by HL7 US Realm Steering Committee.
Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Practitioner | 0..* | US Core Practitioner | ||
  identifier | S | 1..* | Identifier | |
  system | S | 1..1 | uri | NPI could be used as the identifier system in the US. Example General': NPI preferred, Tax id is allowed, Local id is allowed in addition to 'authoritative' identifier |
 value | S | 1..1 | string | |
| name | S | 1..1 | HumanName | |
 family | S | 1..1 | string | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Practitioner | I | 0..* | US Core Practitioner | |
| 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: Common Languages (extensible) | |
| text | I | 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 |
| identifier | SΣ | 1..* | Identifier | A identifier for the person as this agent |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required) |
| type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) |
| system | SΣ | 1..1 | uri | NPI could be used as the identifier system in the US. Example General': http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri Example General': NPI preferred, Tax id is allowed, Local id is allowed in addition to 'authoritative' identifier |
| 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) |
| active | Σ | 0..1 | boolean | Whether this practitioner's record is in active use |
| name | SΣ | 1..1 | HumanName | The name(s) associated with the practitioner |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| use | ?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required) |
| 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 | Σ | 0..* | ContactPoint | A contact detail for the practitioner (that apply to all roles) |
| address | Σ | 0..* | Address | Address(es) of the practitioner that are not role specific (typically home address) |
| gender | Σ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required) |
| birthDate | Σ | 0..1 | date | The date on which the practitioner was born |
| photo | 0..* | Attachment | Image of the person | |
| qualification | I | 0..* | BackboneElement | Qualifications obtained by training and certification |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| 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) | |
| 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 is able to use in patient communication Binding: Common Languages (extensible) | |
| Documentation for this format | ||||
Differential View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Practitioner | 0..* | US Core Practitioner | ||
| identifier | S | 1..* | Identifier | |
| system | S | 1..1 | uri | NPI could be used as the identifier system in the US. Example General': NPI preferred, Tax id is allowed, Local id is allowed in addition to 'authoritative' identifier |
| value | S | 1..1 | string | |
| name | S | 1..1 | HumanName | |
| family | S | 1..1 | string | |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Practitioner | I | 0..* | US Core Practitioner | |
| 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: Common Languages (extensible) | |
| text | I | 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 |
| identifier | SΣ | 1..* | Identifier | A identifier for the person as this agent |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required) |
| type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) |
| system | SΣ | 1..1 | uri | NPI could be used as the identifier system in the US. Example General': http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri Example General': NPI preferred, Tax id is allowed, Local id is allowed in addition to 'authoritative' identifier |
| 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) |
| active | Σ | 0..1 | boolean | Whether this practitioner's record is in active use |
| name | SΣ | 1..1 | HumanName | The name(s) associated with the practitioner |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| use | ?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required) |
| 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 | Σ | 0..* | ContactPoint | A contact detail for the practitioner (that apply to all roles) |
| address | Σ | 0..* | Address | Address(es) of the practitioner that are not role specific (typically home address) |
| gender | Σ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required) |
| birthDate | Σ | 0..1 | date | The date on which the practitioner was born |
| photo | 0..* | Attachment | Image of the person | |
| qualification | I | 0..* | BackboneElement | Qualifications obtained by training and certification |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| 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) | |
| 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 is able to use in patient communication Binding: Common Languages (extensible) | |
| Documentation for this format | ||||
Downloads: StructureDefinition: (XML, JSON, CSV), Schema: XML Schematron
Below is an overview of the required search and read operations for this profile. See the Conformance requirements for the US Core Server for a complete list of supported RESTful operations and search parameters for this IG.
GET [base]/Practitioner?identifier=[system]|[code]
Example: GET [base]/Practitioner?identifier=http://hl7.org/fhir/sid/us-npi%7C1497860456
Support: Mandatory
Implementation Notes: Search based on practitioner identifier (how to search by token).
Response Class:
GET [base]/Practitioner?family=[string]&given=[string]
Example: GET [base]/Practitioner?family=Smith&given=John
Support: Mandatory
Implementation Notes: Search based on text name (how to search by string).
Response Class:
US Core © v1.0.0 (STU1) based on FHIR Release 3 (STU; 3.0.0) generated on Tue, Mar 21, 2017 11:28+1100. |
