Universal API Implementation Guide - Local Development build (v1.1.19). See the Directory of published versions
Resource Profile: UAPI Practitioner
| Official URL: https://fhir.developer.gene.com/StructureDefinition/uapi-practitioner | Version: 1.1.19 | |||
| Active as of 2021-05-06 | Responsible: Genentech USIX PE |
Realm: 
|
Computable Name: UapiPractitioner | |
This profile constrains the Practitioner resource to be included in UAPI data exchanges
Usage:
- Use this Resource Profile: UAPI Bundle - AS Enrollment, UAPI Bundle - Copay Enrollment, UAPI Bundle - Copay Request-Response
- Refer to this Resource Profile: UAPI Bundle - AS Enrollment, UAPI Bundle - Copay Enrollment, UAPI Bundle - Copay Request-Response
Formal Views of Profile Content
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Practitioner
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Practitioner | 0..* | Practitioner | A person with a formal responsibility in the provisioning of healthcare or related services | |
  Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
 preferredContactMethod | 0..1 | CodeableConcept | UAPI Practitioner Preferred Contact Method URL: https://fhir.developer.gene.com/StructureDefinition/uapi-preferred-contact-method Binding: UAPI Value Set - Prescriber Contact Method (required) | |
| preferredContactTime | 0..1 | CodeableConcept | UAPI Practitioner Shipment Method URL: https://fhir.developer.gene.com/StructureDefinition/uapi-preferred-contact-time Binding: UAPI Value Set - Prescriber Contact Method (required) | |
  identifier | S | 1..* | Identifier | An identifier for the person as this agent |
 use | 1..1 | code | At least one identifier's use must equal official | |
| type | ||||
 coding | ||||
 system | 1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203 | |
 code | 1..1 | code | Symbol in syntax defined by the system | |
| value | 1..1 | string | The value that is unique | |
| name | S | 1..* | HumanName | The name(s) associated with the practitioner |
| family | 1..1 | string | Up to 255 Characters | |
| given | 1..2 | string | Up to 255 Characters | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Practitioner | 0..* | Practitioner | 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 |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| preferredContactMethod | 0..1 | CodeableConcept | UAPI Practitioner Preferred Contact Method URL: https://fhir.developer.gene.com/StructureDefinition/uapi-preferred-contact-method Binding: UAPI Value Set - Prescriber Contact Method (required) | |
| preferredContactTime | 0..1 | CodeableConcept | UAPI Practitioner Shipment Method URL: https://fhir.developer.gene.com/StructureDefinition/uapi-preferred-contact-time Binding: UAPI Value Set - Prescriber Contact Method (required) | |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
 identifier | SΣ | 1..* | Identifier | An identifier for the person as this agent |
| use | ?!Σ | 1..1 | code | At least one identifier's use must equal official Binding: IdentifierUse (required) |
| value | Σ | 1..1 | string | The value that is unique Example General: 123456 |
| name | SΣ | 1..* | HumanName | The name(s) associated with the practitioner |
| use | ?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required) |
| family | Σ | 1..1 | string | Up to 255 Characters |
| given | Σ | 1..2 | string | Up to 255 Characters This repeating element order: Given Names appear in the correct order for presenting the name |
| Documentation for this format | ||||
Terminology Bindings
| Path | Conformance | ValueSet |
| Practitioner.identifier.use | required | IdentifierUse |
| Practitioner.name.use | required | NameUse |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Practitioner | 0..* | Practitioner | 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): IETF language tag
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| preferredContactMethod | 0..1 | CodeableConcept | UAPI Practitioner Preferred Contact Method URL: https://fhir.developer.gene.com/StructureDefinition/uapi-preferred-contact-method Binding: UAPI Value Set - Prescriber Contact Method (required) | |||||
| preferredContactTime | 0..1 | CodeableConcept | UAPI Practitioner Shipment Method URL: https://fhir.developer.gene.com/StructureDefinition/uapi-preferred-contact-time Binding: UAPI Value Set - Prescriber Contact Method (required) | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier | SΣ | 1..* | Identifier | An identifier for the person as this agent | ||||
| id | 0..1 | id | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use | ?!Σ | 1..1 | code | At least one identifier's use must equal official Binding: IdentifierUse (required) | ||||
| type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) | ||||
| id | 0..1 | id | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
| id | 0..1 | id | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system | Σ | 1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203 | ||||
| version | Σ | 0..1 | string | Version of the system - if relevant | ||||
| code | Σ | 1..1 | code | Symbol in syntax defined by the system | ||||
| display | Σ | 0..1 | string | Representation defined by the system | ||||
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
| text | Σ | 0..1 | string | Plain text representation of the concept | ||||
| system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
| value | Σ | 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..* | HumanName | The name(s) associated with the practitioner | ||||
| id | 0..1 | id | 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) | ||||
| text | Σ | 0..1 | string | Text representation of the full name | ||||
| family | Σ | 1..1 | string | Up to 255 Characters | ||||
| given | Σ | 1..2 | string | Up to 255 Characters 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): 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: http://terminology.hl7.org/ValueSet/v2-2.7-0360 (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): IETF language tag
| |||||
| Documentation for this format | ||||||||
Terminology Bindings
| 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.gender | required | AdministrativeGender | ||||
| Practitioner.qualification.code | example | http://terminology.hl7.org/ValueSet/v2-2.7-0360 | ||||
| Practitioner.communication | preferred | CommonLanguages
|
This structure is derived from Practitioner
Differential View
This structure is derived from Practitioner
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Practitioner | 0..* | Practitioner | A person with a formal responsibility in the provisioning of healthcare or related services | |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| preferredContactMethod | 0..1 | CodeableConcept | UAPI Practitioner Preferred Contact Method URL: https://fhir.developer.gene.com/StructureDefinition/uapi-preferred-contact-method Binding: UAPI Value Set - Prescriber Contact Method (required) | |
| preferredContactTime | 0..1 | CodeableConcept | UAPI Practitioner Shipment Method URL: https://fhir.developer.gene.com/StructureDefinition/uapi-preferred-contact-time Binding: UAPI Value Set - Prescriber Contact Method (required) | |
| identifier | S | 1..* | Identifier | An identifier for the person as this agent |
| use | 1..1 | code | At least one identifier's use must equal official | |
| type | ||||
| coding | ||||
| system | 1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203 | |
| code | 1..1 | code | Symbol in syntax defined by the system | |
| value | 1..1 | string | The value that is unique | |
| name | S | 1..* | HumanName | The name(s) associated with the practitioner |
| family | 1..1 | string | Up to 255 Characters | |
| given | 1..2 | string | Up to 255 Characters | |
| Documentation for this format | ||||
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Practitioner | 0..* | Practitioner | 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 |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| preferredContactMethod | 0..1 | CodeableConcept | UAPI Practitioner Preferred Contact Method URL: https://fhir.developer.gene.com/StructureDefinition/uapi-preferred-contact-method Binding: UAPI Value Set - Prescriber Contact Method (required) | |
| preferredContactTime | 0..1 | CodeableConcept | UAPI Practitioner Shipment Method URL: https://fhir.developer.gene.com/StructureDefinition/uapi-preferred-contact-time Binding: UAPI Value Set - Prescriber Contact Method (required) | |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier | SΣ | 1..* | Identifier | An identifier for the person as this agent |
| use | ?!Σ | 1..1 | code | At least one identifier's use must equal official Binding: IdentifierUse (required) |
| value | Σ | 1..1 | string | The value that is unique Example General: 123456 |
| name | SΣ | 1..* | HumanName | The name(s) associated with the practitioner |
| use | ?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required) |
| family | Σ | 1..1 | string | Up to 255 Characters |
| given | Σ | 1..2 | string | Up to 255 Characters This repeating element order: Given Names appear in the correct order for presenting the name |
| Documentation for this format | ||||
Terminology Bindings
| Path | Conformance | ValueSet |
| Practitioner.identifier.use | required | IdentifierUse |
| Practitioner.name.use | required | NameUse |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Practitioner | 0..* | Practitioner | 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): IETF language tag
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| preferredContactMethod | 0..1 | CodeableConcept | UAPI Practitioner Preferred Contact Method URL: https://fhir.developer.gene.com/StructureDefinition/uapi-preferred-contact-method Binding: UAPI Value Set - Prescriber Contact Method (required) | |||||
| preferredContactTime | 0..1 | CodeableConcept | UAPI Practitioner Shipment Method URL: https://fhir.developer.gene.com/StructureDefinition/uapi-preferred-contact-time Binding: UAPI Value Set - Prescriber Contact Method (required) | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier | SΣ | 1..* | Identifier | An identifier for the person as this agent | ||||
| id | 0..1 | id | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use | ?!Σ | 1..1 | code | At least one identifier's use must equal official Binding: IdentifierUse (required) | ||||
| type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) | ||||
| id | 0..1 | id | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
| id | 0..1 | id | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system | Σ | 1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203 | ||||
| version | Σ | 0..1 | string | Version of the system - if relevant | ||||
| code | Σ | 1..1 | code | Symbol in syntax defined by the system | ||||
| display | Σ | 0..1 | string | Representation defined by the system | ||||
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
| text | Σ | 0..1 | string | Plain text representation of the concept | ||||
| system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
| value | Σ | 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..* | HumanName | The name(s) associated with the practitioner | ||||
| id | 0..1 | id | 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) | ||||
| text | Σ | 0..1 | string | Text representation of the full name | ||||
| family | Σ | 1..1 | string | Up to 255 Characters | ||||
| given | Σ | 1..2 | string | Up to 255 Characters 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): 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: http://terminology.hl7.org/ValueSet/v2-2.7-0360 (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): IETF language tag
| |||||
| Documentation for this format | ||||||||
Terminology Bindings
| 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.gender | required | AdministrativeGender | ||||
| Practitioner.qualification.code | example | http://terminology.hl7.org/ValueSet/v2-2.7-0360 | ||||
| Practitioner.communication | preferred | CommonLanguages
|
This structure is derived from Practitioner
Other representations of profile: CSV, Excel, Schematron