Open Health Hub FHIR Implementation Guide
0.1.0 - v0.1.0

Open Health Hub FHIR Implementation Guide - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: OHH Practitioner

Official URL: https://api.openhealthhub.com/OpenHealthhub/fhir/4/StructureDefinition/practitioner-with-key Version: 0.1.0
Active as of 2026-10-27 Computable Name: PractitionerWithKey

Practitioner representation used by the Open Health Hub Platform for both care providers (with public key) and caregivers (with signature).

Scope and Usage

The Practitioner resembles a user in the Open Health Hub Platform. There are two types of users:

  • A program care provider participant (see below), this is a participant that can view the responses of the questionnaires. The Practitioner resource for this type of participant can be used to retrieve a public key used for encrypting a QuestionnaireResponse.
  • A program caregiver participant. This is a participant that is supposed to fill out questionnaires about the patient as part of the program. This participant has a specific role in the program and has a name and email address. The caregiver participant will also have an extension with url https://api.openhealthhub.com/OpenHealthhub/fhir/4/StructureDefinition/caregiver-signature which contains the signature of the user uuid. This can be used to construct the form filler url.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from Practitioner

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Practitioner C 0..* Practitioner A person with a formal responsibility in the provisioning of healthcare or related services
Constraints: practitioner-extension-rule
Practitioner.id This element must be supported. 1..1 id Logical id of this artifact
Practitioner.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Practitioner.Slices for extension.extension:participantProgramPublicKey 0..1 string Participant Program Public Key
URL: https://api.openhealthhub.com/OpenHealthhub/fhir/4/StructureDefinition/participant-program-public-key
Practitioner.Slices for extension.extension:caregiverSignature 0..1 string Caregiver Signature
URL: https://api.openhealthhub.com/OpenHealthhub/fhir/4/StructureDefinition/caregiver-signature
Practitioner.name This element must be supported. 0..1 HumanName The name(s) associated with the practitioner
Practitioner.name.text This element must be supported. 0..1 string Text representation of the full name
Practitioner.Slices for telecom.telecom:email This element must be supported. 0..1 ContactPoint A contact detail for the practitioner (that apply to all roles)
Practitioner.Slices for telecom.telecom:email.system 1..1 code phone | fax | email | pager | url | sms | other
Required Pattern: email (extensions allowed)
Practitioner.Slices for telecom.telecom:email.value This element must be supported. 0..1 string The actual contact point details

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
practitioner-extension-rule warning Practitioner A Practitioner must have a public key extension (for care providers) or a signature extension (for caregivers) extension.where(url = 'https://api.openhealthhub.com/OpenHealthhub/fhir/4/StructureDefinition/participant-program-public-key').exists() or extension.where(url = 'https://api.openhealthhub.com/OpenHealthhub/fhir/4/StructureDefinition/caregiver-signature').exists()
NameFlagsCard.TypeDescription & Constraints    Filter: doco
Practitioner C 0..* Practitioner A person with a formal responsibility in the provisioning of healthcare or related services
Constraints: practitioner-extension-rule
Practitioner.id This element must be supported. This element is included in summaries. 1..1 id Logical id of this artifact
Practitioner.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Practitioner.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Practitioner.Slices for extension.extension:participantProgramPublicKey 0..1 string Participant Program Public Key
URL: https://api.openhealthhub.com/OpenHealthhub/fhir/4/StructureDefinition/participant-program-public-key
Practitioner.Slices for extension.extension:caregiverSignature 0..1 string Caregiver Signature
URL: https://api.openhealthhub.com/OpenHealthhub/fhir/4/StructureDefinition/caregiver-signature
Practitioner.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Practitioner.name This element must be supported. This element is included in summaries. 0..1 HumanName The name(s) associated with the practitioner
Practitioner.name.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
Practitioner.name.text This element must be supported. This element is included in summaries. 0..1 string Text representation of the full name
Practitioner.Slices for telecom This element must be supported. This element is included in summaries. 0..1 ContactPoint A contact detail for the practitioner (that apply to all roles)
Slice: Unordered, Open by value:system

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Practitioner.Slices for telecom.telecom:email This element must be supported. This element is included in summaries. 0..1 ContactPoint A contact detail for the practitioner (that apply to all roles)
Practitioner.Slices for telecom.telecom:email.system This element is included in summaries. C 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Required Pattern: email (extensions allowed)
Practitioner.Slices for telecom.telecom:email.value This element must be supported. This element is included in summaries. 0..1 string The actual contact point details
Practitioner.Slices for telecom.telecom:email.use This element is a modifier element. This element is included in summaries. 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Practitioner.name.use Base required NameUse 📍4.0.1 FHIR Std.
Practitioner.telecom:email.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
Practitioner.telecom:email.​use Base required ContactPointUse 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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()
practitioner-extension-rule warning Practitioner A Practitioner must have a public key extension (for care providers) or a signature extension (for caregivers) extension.where(url = 'https://api.openhealthhub.com/OpenHealthhub/fhir/4/StructureDefinition/participant-program-public-key').exists() or extension.where(url = 'https://api.openhealthhub.com/OpenHealthhub/fhir/4/StructureDefinition/caregiver-signature').exists()
NameFlagsCard.TypeDescription & Constraints    Filter: doco
Practitioner C 0..* Practitioner A person with a formal responsibility in the provisioning of healthcare or related services
Constraints: practitioner-extension-rule
Practitioner.id This element must be supported. This element is included in summaries. 1..1 id Logical id of this artifact
Practitioner.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Practitioner.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Practitioner.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
Practitioner.text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
Practitioner.contained 0..* Resource Contained, inline Resources
Practitioner.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Practitioner.Slices for extension.extension:participantProgramPublicKey 0..1 string Participant Program Public Key
URL: https://api.openhealthhub.com/OpenHealthhub/fhir/4/StructureDefinition/participant-program-public-key
Practitioner.Slices for extension.extension:caregiverSignature 0..1 string Caregiver Signature
URL: https://api.openhealthhub.com/OpenHealthhub/fhir/4/StructureDefinition/caregiver-signature
Practitioner.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Practitioner.identifier This element is included in summaries. 0..* Identifier An identifier for the person as this agent
Practitioner.active This element is included in summaries. 0..1 boolean Whether this practitioner's record is in active use
Practitioner.name This element must be supported. This element is included in summaries. 0..1 HumanName The name(s) associated with the practitioner
Practitioner.name.id 0..1 string Unique id for inter-element referencing
Practitioner.name.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Practitioner.name.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
Practitioner.name.text This element must be supported. This element is included in summaries. 0..1 string Text representation of the full name
Practitioner.name.family This element is included in summaries. 0..1 string Family name (often called 'Surname')
Practitioner.name.given This element is included in summaries. 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
Practitioner.name.prefix This element is included in summaries. 0..* string Parts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
Practitioner.name.suffix This element is included in summaries. 0..* string Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
Practitioner.name.period This element is included in summaries. 0..1 Period Time period when name was/is in use
Practitioner.Slices for telecom This element must be supported. This element is included in summaries. 0..1 ContactPoint A contact detail for the practitioner (that apply to all roles)
Slice: Unordered, Open by value:system

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Practitioner.Slices for telecom.telecom:email This element must be supported. This element is included in summaries. 0..1 ContactPoint A contact detail for the practitioner (that apply to all roles)
Practitioner.Slices for telecom.telecom:email.id 0..1 string Unique id for inter-element referencing
Practitioner.Slices for telecom.telecom:email.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Practitioner.Slices for telecom.telecom:email.system This element is included in summaries. C 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Required Pattern: email (extensions allowed)
Practitioner.Slices for telecom.telecom:email.value This element must be supported. This element is included in summaries. 0..1 string The actual contact point details
Practitioner.Slices for telecom.telecom:email.use This element is a modifier element. This element is included in summaries. 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
Practitioner.Slices for telecom.telecom:email.rank This element is included in summaries. 0..1 positiveInt Specify preferred order of use (1 = highest)
Practitioner.Slices for telecom.telecom:email.period This element is included in summaries. 0..1 Period Time period when the contact point was/is in use
Practitioner.address This element is included in summaries. 0..* Address Address(es) of the practitioner that are not role specific (typically home address)
Practitioner.gender This element is included in summaries. 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
Practitioner.birthDate This element is included in summaries. 0..1 date The date on which the practitioner was born
Practitioner.photo 0..* Attachment Image of the person
Practitioner.qualification 0..* BackboneElement Certification, licenses, or training pertaining to the provision of care
Practitioner.qualification.id 0..1 string Unique id for inter-element referencing
Practitioner.qualification.extension 0..* Extension Additional content defined by implementations
Practitioner.qualification.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Practitioner.qualification.identifier 0..* Identifier An identifier for this qualification for the practitioner
Practitioner.qualification.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.
Practitioner.qualification.period 0..1 Period Period during which the qualification is valid
Practitioner.qualification.issuer 0..1 Reference(Organization) Organization that regulates and issues the qualification
Practitioner.communication 0..* CodeableConcept A language the practitioner can use in patient communication
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding


doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Practitioner.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Practitioner.name.use Base required NameUse 📍4.0.1 FHIR Std.
Practitioner.telecom:email.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
Practitioner.telecom:email.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
Practitioner.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
Practitioner.qualification.​code Base example v2 table 0360, Version 2.7 📦0360 FHIR Std.
Practitioner.communication Base preferred Common Languages 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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()
practitioner-extension-rule warning Practitioner A Practitioner must have a public key extension (for care providers) or a signature extension (for caregivers) extension.where(url = 'https://api.openhealthhub.com/OpenHealthhub/fhir/4/StructureDefinition/participant-program-public-key').exists() or extension.where(url = 'https://api.openhealthhub.com/OpenHealthhub/fhir/4/StructureDefinition/caregiver-signature').exists()

This structure is derived from Practitioner

Summary

Mandatory: 1 element(1 nested mandatory element)
Must-Support: 6 elements

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Practitioner.telecom

Differential View

This structure is derived from Practitioner

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Practitioner C 0..* Practitioner A person with a formal responsibility in the provisioning of healthcare or related services
Constraints: practitioner-extension-rule
Practitioner.id This element must be supported. 1..1 id Logical id of this artifact
Practitioner.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Practitioner.Slices for extension.extension:participantProgramPublicKey 0..1 string Participant Program Public Key
URL: https://api.openhealthhub.com/OpenHealthhub/fhir/4/StructureDefinition/participant-program-public-key
Practitioner.Slices for extension.extension:caregiverSignature 0..1 string Caregiver Signature
URL: https://api.openhealthhub.com/OpenHealthhub/fhir/4/StructureDefinition/caregiver-signature
Practitioner.name This element must be supported. 0..1 HumanName The name(s) associated with the practitioner
Practitioner.name.text This element must be supported. 0..1 string Text representation of the full name
Practitioner.Slices for telecom This element must be supported. 0..1 ContactPoint A contact detail for the practitioner (that apply to all roles)
Slice: Unordered, Open by value:system
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Practitioner.Slices for telecom.telecom:email This element must be supported. 0..1 ContactPoint A contact detail for the practitioner (that apply to all roles)
Practitioner.Slices for telecom.telecom:email.system 1..1 code phone | fax | email | pager | url | sms | other
Required Pattern: email (extensions allowed)
Practitioner.Slices for telecom.telecom:email.value This element must be supported. 0..1 string The actual contact point details

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
practitioner-extension-rule warning Practitioner A Practitioner must have a public key extension (for care providers) or a signature extension (for caregivers) extension.where(url = 'https://api.openhealthhub.com/OpenHealthhub/fhir/4/StructureDefinition/participant-program-public-key').exists() or extension.where(url = 'https://api.openhealthhub.com/OpenHealthhub/fhir/4/StructureDefinition/caregiver-signature').exists()

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Practitioner C 0..* Practitioner A person with a formal responsibility in the provisioning of healthcare or related services
Constraints: practitioner-extension-rule
Practitioner.id This element must be supported. This element is included in summaries. 1..1 id Logical id of this artifact
Practitioner.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Practitioner.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Practitioner.Slices for extension.extension:participantProgramPublicKey 0..1 string Participant Program Public Key
URL: https://api.openhealthhub.com/OpenHealthhub/fhir/4/StructureDefinition/participant-program-public-key
Practitioner.Slices for extension.extension:caregiverSignature 0..1 string Caregiver Signature
URL: https://api.openhealthhub.com/OpenHealthhub/fhir/4/StructureDefinition/caregiver-signature
Practitioner.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Practitioner.name This element must be supported. This element is included in summaries. 0..1 HumanName The name(s) associated with the practitioner
Practitioner.name.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
Practitioner.name.text This element must be supported. This element is included in summaries. 0..1 string Text representation of the full name
Practitioner.Slices for telecom This element must be supported. This element is included in summaries. 0..1 ContactPoint A contact detail for the practitioner (that apply to all roles)
Slice: Unordered, Open by value:system

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Practitioner.Slices for telecom.telecom:email This element must be supported. This element is included in summaries. 0..1 ContactPoint A contact detail for the practitioner (that apply to all roles)
Practitioner.Slices for telecom.telecom:email.system This element is included in summaries. C 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Required Pattern: email (extensions allowed)
Practitioner.Slices for telecom.telecom:email.value This element must be supported. This element is included in summaries. 0..1 string The actual contact point details
Practitioner.Slices for telecom.telecom:email.use This element is a modifier element. This element is included in summaries. 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Practitioner.name.use Base required NameUse 📍4.0.1 FHIR Std.
Practitioner.telecom:email.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
Practitioner.telecom:email.​use Base required ContactPointUse 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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()
practitioner-extension-rule warning Practitioner A Practitioner must have a public key extension (for care providers) or a signature extension (for caregivers) extension.where(url = 'https://api.openhealthhub.com/OpenHealthhub/fhir/4/StructureDefinition/participant-program-public-key').exists() or extension.where(url = 'https://api.openhealthhub.com/OpenHealthhub/fhir/4/StructureDefinition/caregiver-signature').exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Practitioner C 0..* Practitioner A person with a formal responsibility in the provisioning of healthcare or related services
Constraints: practitioner-extension-rule
Practitioner.id This element must be supported. This element is included in summaries. 1..1 id Logical id of this artifact
Practitioner.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Practitioner.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Practitioner.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
Practitioner.text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
Practitioner.contained 0..* Resource Contained, inline Resources
Practitioner.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Practitioner.Slices for extension.extension:participantProgramPublicKey 0..1 string Participant Program Public Key
URL: https://api.openhealthhub.com/OpenHealthhub/fhir/4/StructureDefinition/participant-program-public-key
Practitioner.Slices for extension.extension:caregiverSignature 0..1 string Caregiver Signature
URL: https://api.openhealthhub.com/OpenHealthhub/fhir/4/StructureDefinition/caregiver-signature
Practitioner.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Practitioner.identifier This element is included in summaries. 0..* Identifier An identifier for the person as this agent
Practitioner.active This element is included in summaries. 0..1 boolean Whether this practitioner's record is in active use
Practitioner.name This element must be supported. This element is included in summaries. 0..1 HumanName The name(s) associated with the practitioner
Practitioner.name.id 0..1 string Unique id for inter-element referencing
Practitioner.name.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Practitioner.name.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required): The use of a human name.
Practitioner.name.text This element must be supported. This element is included in summaries. 0..1 string Text representation of the full name
Practitioner.name.family This element is included in summaries. 0..1 string Family name (often called 'Surname')
Practitioner.name.given This element is included in summaries. 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
Practitioner.name.prefix This element is included in summaries. 0..* string Parts that come before the name
This repeating element order: Prefixes appear in the correct order for presenting the name
Practitioner.name.suffix This element is included in summaries. 0..* string Parts that come after the name
This repeating element order: Suffixes appear in the correct order for presenting the name
Practitioner.name.period This element is included in summaries. 0..1 Period Time period when name was/is in use
Practitioner.Slices for telecom This element must be supported. This element is included in summaries. 0..1 ContactPoint A contact detail for the practitioner (that apply to all roles)
Slice: Unordered, Open by value:system

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Practitioner.Slices for telecom.telecom:email This element must be supported. This element is included in summaries. 0..1 ContactPoint A contact detail for the practitioner (that apply to all roles)
Practitioner.Slices for telecom.telecom:email.id 0..1 string Unique id for inter-element referencing
Practitioner.Slices for telecom.telecom:email.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Practitioner.Slices for telecom.telecom:email.system This element is included in summaries. C 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Required Pattern: email (extensions allowed)
Practitioner.Slices for telecom.telecom:email.value This element must be supported. This element is included in summaries. 0..1 string The actual contact point details
Practitioner.Slices for telecom.telecom:email.use This element is a modifier element. This element is included in summaries. 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.
Practitioner.Slices for telecom.telecom:email.rank This element is included in summaries. 0..1 positiveInt Specify preferred order of use (1 = highest)
Practitioner.Slices for telecom.telecom:email.period This element is included in summaries. 0..1 Period Time period when the contact point was/is in use
Practitioner.address This element is included in summaries. 0..* Address Address(es) of the practitioner that are not role specific (typically home address)
Practitioner.gender This element is included in summaries. 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
Practitioner.birthDate This element is included in summaries. 0..1 date The date on which the practitioner was born
Practitioner.photo 0..* Attachment Image of the person
Practitioner.qualification 0..* BackboneElement Certification, licenses, or training pertaining to the provision of care
Practitioner.qualification.id 0..1 string Unique id for inter-element referencing
Practitioner.qualification.extension 0..* Extension Additional content defined by implementations
Practitioner.qualification.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Practitioner.qualification.identifier 0..* Identifier An identifier for this qualification for the practitioner
Practitioner.qualification.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.
Practitioner.qualification.period 0..1 Period Period during which the qualification is valid
Practitioner.qualification.issuer 0..1 Reference(Organization) Organization that regulates and issues the qualification
Practitioner.communication 0..* CodeableConcept A language the practitioner can use in patient communication
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding


doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Practitioner.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Practitioner.name.use Base required NameUse 📍4.0.1 FHIR Std.
Practitioner.telecom:email.​system Base required ContactPointSystem 📍4.0.1 FHIR Std.
Practitioner.telecom:email.​use Base required ContactPointUse 📍4.0.1 FHIR Std.
Practitioner.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.
Practitioner.qualification.​code Base example v2 table 0360, Version 2.7 📦0360 FHIR Std.
Practitioner.communication Base preferred Common Languages 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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()
practitioner-extension-rule warning Practitioner A Practitioner must have a public key extension (for care providers) or a signature extension (for caregivers) extension.where(url = 'https://api.openhealthhub.com/OpenHealthhub/fhir/4/StructureDefinition/participant-program-public-key').exists() or extension.where(url = 'https://api.openhealthhub.com/OpenHealthhub/fhir/4/StructureDefinition/caregiver-signature').exists()

This structure is derived from Practitioner

Summary

Mandatory: 1 element(1 nested mandatory element)
Must-Support: 6 elements

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Practitioner.telecom

 

Other representations of profile: CSV, Excel, Schematron

Notes:

Retrieving Practitioners

Retrieving a Practitioner by ID is currently only possible for the client itself. To search for other Practitioners, you’ll need to search them by CareTeam id.