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 2025-12-03 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: Filtersdoco
.. Practitioner C 0..* Practitioner A person with a formal responsibility in the provisioning of healthcare or related services
Constraints: practitioner-extension-rule
... id S 1..1 id Logical id of this artifact
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:participantProgramPublicKey 0..1 string Participant Program Public Key
URL: https://api.openhealthhub.com/OpenHealthhub/fhir/4/StructureDefinition/participant-program-public-key
.... extension:caregiverSignature 0..1 string Caregiver Signature
URL: https://api.openhealthhub.com/OpenHealthhub/fhir/4/StructureDefinition/caregiver-signature
... identifier S 0..1 Identifier An identifier for the person as this agent
.... system 0..1 uri The namespace for the identifier value
Required Pattern: urn:ietf:rfc:3986
.... value S 0..1 string The value that is unique
.... text S 0..1 string Text representation of the full name
... Slices for telecom S 0..1 ContactPoint A contact detail for the practitioner (that apply to all roles)
Slice: Unordered, Open by value:system
.... telecom:email S 0..1 ContactPoint A contact detail for the practitioner (that apply to all roles)
..... system 1..1 code phone | fax | email | pager | url | sms | other
Required Pattern: email
..... value S 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: Filtersdoco
.. Practitioner C 0..* Practitioner A person with a formal responsibility in the provisioning of healthcare or related services
Constraints: practitioner-extension-rule
... id SΣ 1..1 id Logical id of this artifact
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:participantProgramPublicKey 0..1 string Participant Program Public Key
URL: https://api.openhealthhub.com/OpenHealthhub/fhir/4/StructureDefinition/participant-program-public-key
.... extension:caregiverSignature 0..1 string Caregiver Signature
URL: https://api.openhealthhub.com/OpenHealthhub/fhir/4/StructureDefinition/caregiver-signature
... identifier SΣ 0..1 Identifier An identifier for the person as this agent
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
.... system Σ 0..1 uri The namespace for the identifier value
Required Pattern: urn:ietf:rfc:3986
.... value SΣ 0..1 string The value that is unique
Example General: 123456
... name SΣ 0..1 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 SΣ 0..1 string Text representation of the full name
... Slices for telecom SΣ 0..1 ContactPoint A contact detail for the practitioner (that apply to all roles)
Slice: Unordered, Open by value:system
.... telecom:email SΣ 0..1 ContactPoint A contact detail for the practitioner (that apply to all roles)
..... system ΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Required Pattern: email
..... value SΣ 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): Use of contact point.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Practitioner.identifier.​use Base required IdentifierUse 📍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.

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: Filtersdoco
.. Practitioner C 0..* Practitioner A person with a formal responsibility in the provisioning of healthcare or related services
Constraints: practitioner-extension-rule
... id SΣ 1..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
... 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
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:participantProgramPublicKey 0..1 string Participant Program Public Key
URL: https://api.openhealthhub.com/OpenHealthhub/fhir/4/StructureDefinition/participant-program-public-key
.... extension:caregiverSignature 0..1 string Caregiver Signature
URL: https://api.openhealthhub.com/OpenHealthhub/fhir/4/StructureDefinition/caregiver-signature
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier SΣ 0..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 ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
.... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
.... system Σ 0..1 uri The namespace for the identifier value
Required Pattern: urn:ietf:rfc:3986
.... value SΣ 0..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Σ 0..1 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 SΣ 0..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
... Slices for telecom SΣ 0..1 ContactPoint A contact detail for the practitioner (that apply to all roles)
Slice: Unordered, Open by value:system
.... telecom:email SΣ 0..1 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 ΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Required Pattern: email
..... value SΣ 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): 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 Σ 0..* Address Address(es) of the practitioner that are not role specific (typically home address)
... gender Σ 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
... birthDate Σ 0..1 date The date on which the practitioner was born
... photo 0..* Attachment Image of the person
... qualification 0..* BackboneElement Certification, licenses, or training pertaining to the provision of care
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... identifier 0..* Identifier An identifier for this qualification for the practitioner
.... code 1..1 CodeableConcept Coded representation of the qualification
Binding: v2 table 0360, Version 2.7 (example): Specific qualification the practitioner has to provide a service.
.... period 0..1 Period Period during which the qualification is valid
.... issuer 0..1 Reference(Organization) Organization that regulates and issues the qualification
... communication 0..* CodeableConcept A language the practitioner can use in patient communication
Binding: CommonLanguages (preferred): 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.identifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Practitioner.identifier.​type Base extensible IdentifierType 📍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: 8 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: Filtersdoco
.. Practitioner C 0..* Practitioner A person with a formal responsibility in the provisioning of healthcare or related services
Constraints: practitioner-extension-rule
... id S 1..1 id Logical id of this artifact
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:participantProgramPublicKey 0..1 string Participant Program Public Key
URL: https://api.openhealthhub.com/OpenHealthhub/fhir/4/StructureDefinition/participant-program-public-key
.... extension:caregiverSignature 0..1 string Caregiver Signature
URL: https://api.openhealthhub.com/OpenHealthhub/fhir/4/StructureDefinition/caregiver-signature
... identifier S 0..1 Identifier An identifier for the person as this agent
.... system 0..1 uri The namespace for the identifier value
Required Pattern: urn:ietf:rfc:3986
.... value S 0..1 string The value that is unique
.... text S 0..1 string Text representation of the full name
... Slices for telecom S 0..1 ContactPoint A contact detail for the practitioner (that apply to all roles)
Slice: Unordered, Open by value:system
.... telecom:email S 0..1 ContactPoint A contact detail for the practitioner (that apply to all roles)
..... system 1..1 code phone | fax | email | pager | url | sms | other
Required Pattern: email
..... value S 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: Filtersdoco
.. Practitioner C 0..* Practitioner A person with a formal responsibility in the provisioning of healthcare or related services
Constraints: practitioner-extension-rule
... id SΣ 1..1 id Logical id of this artifact
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:participantProgramPublicKey 0..1 string Participant Program Public Key
URL: https://api.openhealthhub.com/OpenHealthhub/fhir/4/StructureDefinition/participant-program-public-key
.... extension:caregiverSignature 0..1 string Caregiver Signature
URL: https://api.openhealthhub.com/OpenHealthhub/fhir/4/StructureDefinition/caregiver-signature
... identifier SΣ 0..1 Identifier An identifier for the person as this agent
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
.... system Σ 0..1 uri The namespace for the identifier value
Required Pattern: urn:ietf:rfc:3986
.... value SΣ 0..1 string The value that is unique
Example General: 123456
... name SΣ 0..1 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 SΣ 0..1 string Text representation of the full name
... Slices for telecom SΣ 0..1 ContactPoint A contact detail for the practitioner (that apply to all roles)
Slice: Unordered, Open by value:system
.... telecom:email SΣ 0..1 ContactPoint A contact detail for the practitioner (that apply to all roles)
..... system ΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Required Pattern: email
..... value SΣ 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): Use of contact point.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Practitioner.identifier.​use Base required IdentifierUse 📍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.

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: Filtersdoco
.. Practitioner C 0..* Practitioner A person with a formal responsibility in the provisioning of healthcare or related services
Constraints: practitioner-extension-rule
... id SΣ 1..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
... 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
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:participantProgramPublicKey 0..1 string Participant Program Public Key
URL: https://api.openhealthhub.com/OpenHealthhub/fhir/4/StructureDefinition/participant-program-public-key
.... extension:caregiverSignature 0..1 string Caregiver Signature
URL: https://api.openhealthhub.com/OpenHealthhub/fhir/4/StructureDefinition/caregiver-signature
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier SΣ 0..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 ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
.... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
.... system Σ 0..1 uri The namespace for the identifier value
Required Pattern: urn:ietf:rfc:3986
.... value SΣ 0..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Σ 0..1 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 SΣ 0..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
... Slices for telecom SΣ 0..1 ContactPoint A contact detail for the practitioner (that apply to all roles)
Slice: Unordered, Open by value:system
.... telecom:email SΣ 0..1 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 ΣC 1..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.
Required Pattern: email
..... value SΣ 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): 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 Σ 0..* Address Address(es) of the practitioner that are not role specific (typically home address)
... gender Σ 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
... birthDate Σ 0..1 date The date on which the practitioner was born
... photo 0..* Attachment Image of the person
... qualification 0..* BackboneElement Certification, licenses, or training pertaining to the provision of care
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... identifier 0..* Identifier An identifier for this qualification for the practitioner
.... code 1..1 CodeableConcept Coded representation of the qualification
Binding: v2 table 0360, Version 2.7 (example): Specific qualification the practitioner has to provide a service.
.... period 0..1 Period Period during which the qualification is valid
.... issuer 0..1 Reference(Organization) Organization that regulates and issues the qualification
... communication 0..* CodeableConcept A language the practitioner can use in patient communication
Binding: CommonLanguages (preferred): 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.identifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
Practitioner.identifier.​type Base extensible IdentifierType 📍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: 8 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.