FHIR Implementation Guide for ABDM
3.1.0 - active
FHIR Implementation Guide for ABDM
3.1.0 - active
FHIR Implementation Guide for ABDM - Local Development build (v3.1.0). See the Directory of published versions
| Official URL: https://nrces.in/ndhm/fhir/r4/StructureDefinition/Practitioner | Version: 3.1.0 | |||
| Draft as of 2020-08-17 | Computable Name: Practitioner | |||
This profile sets minimum expectations for the Practitioner resource to record, search, and fetch basic demographics and other administrative information about an individual practitioner.
This profile sets minimum expectations for the Practitioner resource to record, search, and fetch basic demographics and other administrative information about an individual practitioner. It identifies which core elements, extensions, vocabularies and value sets SHALL be present in the resource when using this profile.
Usage:
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 | |
  identifier | S | 1..* | Identifier | An identifier for the person as this agent |
  use | S | 0..1 | code | usual | official | temp | secondary | old (If known) |
| type | S | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Code (extensible) |
| coding | S | 0..* | Coding | Code defined by a terminology system |
| code | 1..1 | code | Symbol in syntax defined by the system | |
 display | 1..1 | string | Representation defined by the system | |
| text | S | 0..1 | string | Plain text representation of the concept |
| system | S | 0..1 | uri | The namespace for the identifier value |
| value | S | 1..1 | string | The value that is unique |
  assigner | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | |
 display | S | 0..1 | string | Text alternative for the resource |
| name | S | 0..* | HumanName | The name(s) associated with the practitioner |
| text | 1..1 | string | Text representation of the full name | |
| telecom | S | 0..* | ContactPoint | A contact detail for the practitioner (that apply to all roles) |
| system | S | 0..1 | code | phone | fax | email | pager | url | sms | other |
| value | 1..1 | string | The actual contact point details | |
| use | S | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point |
| address | S | 0..* | Address | Address(es) of the practitioner that are not role specific (typically home address) |
| gender | S | 0..1 | code | male | female | other | unknown |
| birthDate | S | 0..1 | date | The date on which the practitioner was born |
| photo | ||||
| contentType | 1..1 | code | Mime type of the content, with charset etc. | |
| data | 1..1 | base64Binary | Data inline, base64ed | |
| qualification | ||||
| code | ||||
| coding | S | 0..* | Coding | Code defined by a terminology system |
| code | 1..1 | code | Symbol in syntax defined by the system | |
| display | 1..1 | string | Representation defined by the system | |
| text | S | 0..1 | string | Plain text representation of the concept |
| issuer | 0..1 | Reference(Organization) | Organization that regulates and issues the qualification | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Practitioner.identifier.type | extensible | IdentifierTypeCode |
| 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 |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
 identifier | SΣ | 1..* | Identifier | An identifier for the person as this agent |
| use | ?!SΣ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| type | SΣ | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Code (extensible) |
| coding | SΣ | 0..* | Coding | Code defined by a terminology system |
| code | Σ | 1..1 | code | Symbol in syntax defined by the system |
| display | Σ | 1..1 | string | Representation defined by the system |
| text | SΣ | 0..1 | string | Plain text representation of the concept |
| system | SΣ | 0..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 |
| assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
| display | SΣ | 0..1 | string | Text alternative for the resource |
| name | SΣ | 0..* | HumanName | The name(s) associated with the practitioner |
| use | ?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. |
| text | Σ | 1..1 | string | Text representation of the full name |
| 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 | Σ | 1..1 | string | The actual contact point details |
| use | ?!SΣ | 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(es) of the practitioner that are not role specific (typically home address) |
| gender | SΣ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. |
| birthDate | SΣ | 0..1 | date | The date on which the practitioner was born |
| qualification | 0..* | BackboneElement | Certification, licenses, or training pertaining to the provision of care | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| 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. | |
| coding | SΣ | 0..* | Coding | Code defined by a terminology system |
| code | Σ | 1..1 | code | Symbol in syntax defined by the system |
| display | Σ | 1..1 | string | Representation defined by the system |
| text | SΣ | 0..1 | string | Plain text representation of the concept |
| issuer | 0..1 | Reference(Organization) | Organization that regulates and issues the qualification | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Practitioner.identifier.use | required | IdentifierUse |
| Practitioner.identifier.type | extensible | IdentifierTypeCode |
| Practitioner.name.use | required | NameUse |
| Practitioner.telecom.system | required | ContactPointSystem |
| Practitioner.telecom.use | required | ContactPointUse |
| 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) |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Practitioner | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Practitioner | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | 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-5 | error | Practitioner | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Practitioner | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
| 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): 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 | ||||
| identifier | SΣ | 1..* | Identifier | An identifier for the person as this agent | ||||
| 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 | ?!SΣ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
| type | SΣ | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Code (extensible) | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding | SΣ | 0..* | Coding | Code defined by a terminology system | ||||
| 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 | Σ | 0..1 | uri | Identity of the terminology system | ||||
| version | Σ | 0..1 | string | Version of the system - if relevant | ||||
| code | Σ | 1..1 | code | Symbol in syntax defined by the system | ||||
| display | Σ | 1..1 | string | Representation defined by the system | ||||
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
| text | SΣ | 0..1 | string | Plain text representation of the concept | ||||
| system | SΣ | 0..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) | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference | ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display | SΣ | 0..1 | string | Text alternative for the resource | ||||
| active | Σ | 0..1 | boolean | Whether this practitioner's record is in active use | ||||
| name | SΣ | 0..* | HumanName | The name(s) associated with the practitioner | ||||
| 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 | Σ | 1..1 | string | Text representation of the full name | ||||
| family | Σ | 0..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 | Σ | 1..1 | string | The actual contact point details | ||||
| use | ?!SΣ | 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(es) of the practitioner that are not role specific (typically home address) | ||||
| gender | SΣ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | ||||
| birthDate | SΣ | 0..1 | date | The date on which the practitioner was born | ||||
| photo | 0..* | Attachment | Image of the person | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| contentType | Σ | 1..1 | code | Mime type of the content, with charset etc. Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. Example General: text/plain; charset=UTF-8, image/png | ||||
| language | Σ | 0..1 | code | Human language of the content (BCP-47) Binding: CommonLanguages (preferred): A human language.
Example General: en-AU | ||||
| data | 1..1 | base64Binary | Data inline, base64ed | |||||
| url | Σ | 0..1 | url | Uri where the data can be found Example General: http://www.acme.com/logo-small.png | ||||
| size | Σ | 0..1 | unsignedInt | Number of bytes of content (if url provided) | ||||
| hash | Σ | 0..1 | base64Binary | Hash of the data (sha-1, base64ed) | ||||
| title | Σ | 0..1 | string | Label to display in place of the data Example General: Official Corporate Logo | ||||
| creation | Σ | 0..1 | dateTime | Date attachment was first created | ||||
| 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. | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding | SΣ | 0..* | Coding | Code defined by a terminology system | ||||
| 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 | Σ | 0..1 | uri | Identity of the terminology system | ||||
| version | Σ | 0..1 | string | Version of the system - if relevant | ||||
| code | Σ | 1..1 | code | Symbol in syntax defined by the system | ||||
| display | Σ | 1..1 | string | Representation defined by the system | ||||
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
| text | SΣ | 0..1 | string | Plain text representation of the concept | ||||
| 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 | IdentifierTypeCode | ||||
| Practitioner.identifier.assigner.type | extensible | ResourceType | ||||
| Practitioner.name.use | required | NameUse | ||||
| Practitioner.telecom.system | required | ContactPointSystem | ||||
| Practitioner.telecom.use | required | ContactPointUse | ||||
| Practitioner.gender | required | AdministrativeGender | ||||
| Practitioner.photo.contentType | required | Mime Types (a valid code from urn:ietf:bcp:13) | ||||
| Practitioner.photo.language | preferred | CommonLanguages
| ||||
| 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
|
| Id | Grade | Path(s) | Details | Requirements |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
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 | |
| identifier | S | 1..* | Identifier | An identifier for the person as this agent |
| use | S | 0..1 | code | usual | official | temp | secondary | old (If known) |
| type | S | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Code (extensible) |
| coding | S | 0..* | Coding | Code defined by a terminology system |
| code | 1..1 | code | Symbol in syntax defined by the system | |
| display | 1..1 | string | Representation defined by the system | |
| text | S | 0..1 | string | Plain text representation of the concept |
| system | S | 0..1 | uri | The namespace for the identifier value |
| value | S | 1..1 | string | The value that is unique |
| assigner | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | |
| display | S | 0..1 | string | Text alternative for the resource |
| name | S | 0..* | HumanName | The name(s) associated with the practitioner |
| text | 1..1 | string | Text representation of the full name | |
| telecom | S | 0..* | ContactPoint | A contact detail for the practitioner (that apply to all roles) |
| system | S | 0..1 | code | phone | fax | email | pager | url | sms | other |
| value | 1..1 | string | The actual contact point details | |
| use | S | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point |
| address | S | 0..* | Address | Address(es) of the practitioner that are not role specific (typically home address) |
| gender | S | 0..1 | code | male | female | other | unknown |
| birthDate | S | 0..1 | date | The date on which the practitioner was born |
| photo | ||||
| contentType | 1..1 | code | Mime type of the content, with charset etc. | |
| data | 1..1 | base64Binary | Data inline, base64ed | |
| qualification | ||||
| code | ||||
| coding | S | 0..* | Coding | Code defined by a terminology system |
| code | 1..1 | code | Symbol in syntax defined by the system | |
| display | 1..1 | string | Representation defined by the system | |
| text | S | 0..1 | string | Plain text representation of the concept |
| issuer | 0..1 | Reference(Organization) | Organization that regulates and issues the qualification | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Practitioner.identifier.type | extensible | IdentifierTypeCode |
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 |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier | SΣ | 1..* | Identifier | An identifier for the person as this agent |
| use | ?!SΣ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| type | SΣ | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Code (extensible) |
| coding | SΣ | 0..* | Coding | Code defined by a terminology system |
| code | Σ | 1..1 | code | Symbol in syntax defined by the system |
| display | Σ | 1..1 | string | Representation defined by the system |
| text | SΣ | 0..1 | string | Plain text representation of the concept |
| system | SΣ | 0..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 |
| assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
| display | SΣ | 0..1 | string | Text alternative for the resource |
| name | SΣ | 0..* | HumanName | The name(s) associated with the practitioner |
| use | ?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. |
| text | Σ | 1..1 | string | Text representation of the full name |
| 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 | Σ | 1..1 | string | The actual contact point details |
| use | ?!SΣ | 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(es) of the practitioner that are not role specific (typically home address) |
| gender | SΣ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. |
| birthDate | SΣ | 0..1 | date | The date on which the practitioner was born |
| qualification | 0..* | BackboneElement | Certification, licenses, or training pertaining to the provision of care | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| 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. | |
| coding | SΣ | 0..* | Coding | Code defined by a terminology system |
| code | Σ | 1..1 | code | Symbol in syntax defined by the system |
| display | Σ | 1..1 | string | Representation defined by the system |
| text | SΣ | 0..1 | string | Plain text representation of the concept |
| issuer | 0..1 | Reference(Organization) | Organization that regulates and issues the qualification | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Practitioner.identifier.use | required | IdentifierUse |
| Practitioner.identifier.type | extensible | IdentifierTypeCode |
| Practitioner.name.use | required | NameUse |
| Practitioner.telecom.system | required | ContactPointSystem |
| Practitioner.telecom.use | required | ContactPointUse |
| 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) |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Practitioner | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Practitioner | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | 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-5 | error | Practitioner | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Practitioner | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
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): 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 | ||||
| identifier | SΣ | 1..* | Identifier | An identifier for the person as this agent | ||||
| 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 | ?!SΣ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
| type | SΣ | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Code (extensible) | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding | SΣ | 0..* | Coding | Code defined by a terminology system | ||||
| 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 | Σ | 0..1 | uri | Identity of the terminology system | ||||
| version | Σ | 0..1 | string | Version of the system - if relevant | ||||
| code | Σ | 1..1 | code | Symbol in syntax defined by the system | ||||
| display | Σ | 1..1 | string | Representation defined by the system | ||||
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
| text | SΣ | 0..1 | string | Plain text representation of the concept | ||||
| system | SΣ | 0..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) | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference | ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display | SΣ | 0..1 | string | Text alternative for the resource | ||||
| active | Σ | 0..1 | boolean | Whether this practitioner's record is in active use | ||||
| name | SΣ | 0..* | HumanName | The name(s) associated with the practitioner | ||||
| 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 | Σ | 1..1 | string | Text representation of the full name | ||||
| family | Σ | 0..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 | Σ | 1..1 | string | The actual contact point details | ||||
| use | ?!SΣ | 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(es) of the practitioner that are not role specific (typically home address) | ||||
| gender | SΣ | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | ||||
| birthDate | SΣ | 0..1 | date | The date on which the practitioner was born | ||||
| photo | 0..* | Attachment | Image of the person | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| contentType | Σ | 1..1 | code | Mime type of the content, with charset etc. Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. Example General: text/plain; charset=UTF-8, image/png | ||||
| language | Σ | 0..1 | code | Human language of the content (BCP-47) Binding: CommonLanguages (preferred): A human language.
Example General: en-AU | ||||
| data | 1..1 | base64Binary | Data inline, base64ed | |||||
| url | Σ | 0..1 | url | Uri where the data can be found Example General: http://www.acme.com/logo-small.png | ||||
| size | Σ | 0..1 | unsignedInt | Number of bytes of content (if url provided) | ||||
| hash | Σ | 0..1 | base64Binary | Hash of the data (sha-1, base64ed) | ||||
| title | Σ | 0..1 | string | Label to display in place of the data Example General: Official Corporate Logo | ||||
| creation | Σ | 0..1 | dateTime | Date attachment was first created | ||||
| 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. | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding | SΣ | 0..* | Coding | Code defined by a terminology system | ||||
| 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 | Σ | 0..1 | uri | Identity of the terminology system | ||||
| version | Σ | 0..1 | string | Version of the system - if relevant | ||||
| code | Σ | 1..1 | code | Symbol in syntax defined by the system | ||||
| display | Σ | 1..1 | string | Representation defined by the system | ||||
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
| text | SΣ | 0..1 | string | Plain text representation of the concept | ||||
| 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 | IdentifierTypeCode | ||||
| Practitioner.identifier.assigner.type | extensible | ResourceType | ||||
| Practitioner.name.use | required | NameUse | ||||
| Practitioner.telecom.system | required | ContactPointSystem | ||||
| Practitioner.telecom.use | required | ContactPointUse | ||||
| Practitioner.gender | required | AdministrativeGender | ||||
| Practitioner.photo.contentType | required | Mime Types (a valid code from urn:ietf:bcp:13) | ||||
| Practitioner.photo.language | preferred | CommonLanguages
| ||||
| 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
|
| Id | Grade | Path(s) | Details | Requirements |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from Practitioner
Other representations of profile: CSV, Excel, Schematron