Current Build
The official URL for this profile is:
http://hl7.org/fhir/fpar/StructureDefinition/fpar-practitioner
This profile builds on US Core Practitioner Profile.
This profile was published on Wed May 03 00:00:00 EDT 2017 as a draft by Healthcare Services Platform Consortium on behalf of Family Planning Annual Report.
Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.
This structure is derived from US Core Practitioner Profile
This structure is derived from US Core Practitioner Profile
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Practitioner | FPAR Practitioner | |||
  identifier | S | 1..* | Identifier | |
   system | S | 1..1 | uri | NPI could be used as the identifier system in the US. |
 value | S | 1..1 | string | |
| name | S | 1..1 | HumanName | |
| family | S | 1..1 | string | |
| telecom | ||||
 extensions-preferenceIndicator | 0..1 | CodeableConcept | Extension URL: http://hl7.org/fhir/fpar/StructureDefinition/extensions-preferenceIndicator | |
| address | ||||
| primaryIndicator | 0..1 | CodeableConcept | Extension URL: http://hl7.org/fhir/fpar/StructureDefinition/extensions-primaryIndicator profiled by http://hl7.org/fhir/fpar/StructureDefinition/primaryIndicator Binding: v2 Yes/no Indicator (preferred) | |
| qualification | ||||
| extension | CodeableConcept | Credential Eligibility Indicator Binding: v2 Yes/no Indicator (preferred) | ||
 communication | ||||
 communicationMode | 0..1 | CodeableConcept | Extension URL: http://hl7.org/fhir/fpar/StructureDefinition/hspc-genencounter-CommunicationMode profiled by http://hl7.org/fhir/fpar/StructureDefinition/communicationMode Binding: HSPC Communication Mode (preferred) | |
| Documentation for this format | ||||
This structure is derived from US Core Practitioner Profile
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Practitioner | I | 0..* | FPAR 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) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| 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 |
| 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) | |
| 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 | 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) |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extensions-preferenceIndicator | I | 0..* | CodeableConcept | Extension URL: http://hl7.org/fhir/fpar/StructureDefinition/extensions-preferenceIndicator ext-1: Must have either extensions or value[x], not both |
| system | ΣI | 0..1 | code | phone | fax | email | pager | other Binding: ContactPointSystem (required) |
| value | Σ | 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) |
| 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 | Σ | 0..* | Address | Address(es) of the practitioner that are not role specific (typically home address) |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| primaryIndicator | I | 0..* | CodeableConcept | Extension URL: http://hl7.org/fhir/fpar/StructureDefinition/extensions-primaryIndicator profiled by http://hl7.org/fhir/fpar/StructureDefinition/primaryIndicator Binding: v2 Yes/no Indicator (preferred) ext-1: Must have either extensions or value[x], not both |
| use | ?!Σ | 0..1 | code | home | work | temp | old - purpose of this address Binding: AddressUse (required) |
| type | Σ | 0..1 | code | postal | physical | both Binding: AddressType (required) |
| text | Σ | 0..1 | string | Text representation of the address |
| line | Σ | 0..* | string | Street name, number, direction, and P.O. Box etc. |
| city | Σ | 0..1 | string | Name of city, town etc. |
| district | Σ | 0..1 | string | District name (aka county) |
| state | Σ | 0..1 | string | Sub-unit of country (abbreviations ok) |
| postalCode | Σ | 0..1 | string | Postal code for area |
| country | Σ | 0..1 | string | Country (can be ISO 3166 3 letter code) |
| period | Σ | 0..1 | Period | Time period when address was/is in use |
| 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 | I | 0..* | CodeableConcept | Credential Eligibility Indicator Binding: v2 Yes/no Indicator (preferred) ext-1: Must have either extensions or value[x], not both |
| 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: anzsco-occupations (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) | |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| communicationMode | I | 0..* | CodeableConcept | Extension URL: http://hl7.org/fhir/fpar/StructureDefinition/hspc-genencounter-CommunicationMode profiled by http://hl7.org/fhir/fpar/StructureDefinition/communicationMode Binding: HSPC Communication Mode (preferred) ext-1: Must have either extensions or value[x], not both |
| coding | Σ | 0..* | Coding | Code defined by a terminology system |
| text | Σ | 0..1 | string | Plain text representation of the concept |
| Documentation for this format | ||||
This structure is derived from US Core Practitioner Profile
Differential View
This structure is derived from US Core Practitioner Profile
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Practitioner | FPAR Practitioner | |||
| identifier | S | 1..* | Identifier | |
| system | S | 1..1 | uri | NPI could be used as the identifier system in the US. |
| value | S | 1..1 | string | |
| name | S | 1..1 | HumanName | |
| family | S | 1..1 | string | |
| telecom | ||||
| extensions-preferenceIndicator | 0..1 | CodeableConcept | Extension URL: http://hl7.org/fhir/fpar/StructureDefinition/extensions-preferenceIndicator | |
| address | ||||
| primaryIndicator | 0..1 | CodeableConcept | Extension URL: http://hl7.org/fhir/fpar/StructureDefinition/extensions-primaryIndicator profiled by http://hl7.org/fhir/fpar/StructureDefinition/primaryIndicator Binding: v2 Yes/no Indicator (preferred) | |
| qualification | ||||
| extension | CodeableConcept | Credential Eligibility Indicator Binding: v2 Yes/no Indicator (preferred) | ||
| communication | ||||
| communicationMode | 0..1 | CodeableConcept | Extension URL: http://hl7.org/fhir/fpar/StructureDefinition/hspc-genencounter-CommunicationMode profiled by http://hl7.org/fhir/fpar/StructureDefinition/communicationMode Binding: HSPC Communication Mode (preferred) | |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Practitioner | I | 0..* | FPAR 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) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| 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 |
| 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) | |
| 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 | 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) |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extensions-preferenceIndicator | I | 0..* | CodeableConcept | Extension URL: http://hl7.org/fhir/fpar/StructureDefinition/extensions-preferenceIndicator ext-1: Must have either extensions or value[x], not both |
| system | ΣI | 0..1 | code | phone | fax | email | pager | other Binding: ContactPointSystem (required) |
| value | Σ | 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) |
| 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 | Σ | 0..* | Address | Address(es) of the practitioner that are not role specific (typically home address) |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| primaryIndicator | I | 0..* | CodeableConcept | Extension URL: http://hl7.org/fhir/fpar/StructureDefinition/extensions-primaryIndicator profiled by http://hl7.org/fhir/fpar/StructureDefinition/primaryIndicator Binding: v2 Yes/no Indicator (preferred) ext-1: Must have either extensions or value[x], not both |
| use | ?!Σ | 0..1 | code | home | work | temp | old - purpose of this address Binding: AddressUse (required) |
| type | Σ | 0..1 | code | postal | physical | both Binding: AddressType (required) |
| text | Σ | 0..1 | string | Text representation of the address |
| line | Σ | 0..* | string | Street name, number, direction, and P.O. Box etc. |
| city | Σ | 0..1 | string | Name of city, town etc. |
| district | Σ | 0..1 | string | District name (aka county) |
| state | Σ | 0..1 | string | Sub-unit of country (abbreviations ok) |
| postalCode | Σ | 0..1 | string | Postal code for area |
| country | Σ | 0..1 | string | Country (can be ISO 3166 3 letter code) |
| period | Σ | 0..1 | Period | Time period when address was/is in use |
| 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 | I | 0..* | CodeableConcept | Credential Eligibility Indicator Binding: v2 Yes/no Indicator (preferred) ext-1: Must have either extensions or value[x], not both |
| 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: anzsco-occupations (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) | |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| communicationMode | I | 0..* | CodeableConcept | Extension URL: http://hl7.org/fhir/fpar/StructureDefinition/hspc-genencounter-CommunicationMode profiled by http://hl7.org/fhir/fpar/StructureDefinition/communicationMode Binding: HSPC Communication Mode (preferred) ext-1: Must have either extensions or value[x], not both |
| coding | Σ | 0..* | Coding | Code defined by a terminology system |
| text | Σ | 0..1 | string | Plain text representation of the concept |
| Documentation for this format | ||||
| Path | Name | Conformance | ValueSet |
| Practitioner.language | Common Languages | extensible | Common Languages |
| Practitioner.identifier.use | IdentifierUse | required | IdentifierUse |
| Practitioner.identifier.type | Identifier Type Codes | extensible | Identifier Type Codes |
| Practitioner.name.use | NameUse | required | NameUse |
| Practitioner.telecom.system | ContactPointSystem | required | ContactPointSystem |
| Practitioner.telecom.use | ContactPointUse | required | ContactPointUse |
| Practitioner.address.extension | v2 Yes/no Indicator | preferred | v2 Yes/no Indicator |
| Practitioner.address.use | AddressUse | required | AddressUse |
| Practitioner.address.type | AddressType | required | AddressType |
| Practitioner.gender | AdministrativeGender | required | AdministrativeGender |
| Practitioner.qualification.extension | v2 Yes/no Indicator | preferred | v2 Yes/no Indicator |
| Practitioner.qualification.code | ?ext | example | http://hl7.org/fhir/ValueSet/anzsco-occupations |
| Practitioner.communication | Common Languages | extensible | Common Languages |
| Practitioner.communication.extension | HSPC Communication Mode | preferred | HSPC Communication Mode |
| Id | Path | Details | Requirements |
| dom-2 | Practitioner | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-1 | Practitioner | If the resource is contained in another resource, it SHALL NOT contain any narrative : contained.text.empty() | |
| dom-4 | Practitioner | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-3 | Practitioner | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource : contained.where(('#'+id in %resource.descendants().reference).not()).empty() | |
| ext-1 | Practitioner.telecom.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ext-1 | Practitioner.address.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Practitioner.qualification | All FHIR elements must have a @value or children : children().count() > id.count() | |
| ext-1 | Practitioner.qualification.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ext-1 | Practitioner.communication.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
© HL7.org 2011+. FHIR STU3 Candidate (v3.0.1-11917) generated on
Fri, Feb 15, 2019 12:55-0500. QA Page
Links: Search 
| Version History | Table of Contents
| 
| Propose a change