Shared Health Specification and Guide Version 5.0


v5.0 of this specification has been superseded by v5.3. v5.3 is compatible but adds additional features for Quebec.

The version (Bundle.meta.tag:version) that is sent in the message will remain PrescribeIT5.0

 

Definitions for the profile-practitioner-nonclinician Profile.

1. Practitioner
Definition

A person who is directly or indirectly involved in the provisioning of healthcare.

Control0..*
Must Supporttrue
Comments

-

Max Length0
2. Practitioner.id
Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

Control1..1
Typeid
Must Supporttrue
Comments

Conformance Note: This will be a GUID assigned by the sending application in the form urn:uuid:[guid]. Ideally, this guid will be consistent for all messages referencing the same practitioner.

Max Length0
3. Practitioner.meta
Definition

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource.

Control0..1
TypeMeta
Max Length0
4. Practitioner.implicitRules
Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.

Control0..1
Typeuri
Is Modifiertrue
Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element as much as possible.

Max Length0
5. Practitioner.language
Definition

The base language in which the resource is written.

Control0..1
BindingThe codes SHALL be taken from http://tools.ietf.org/html/bcp47 A human language.
Typecode
Comments

Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

Max Length0
6. Practitioner.text
Definition

A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

Control0..1 This element is affected by the following invariants: dom-1
TypeNarrative
Alternate Namesnarrative, html, xhtml, display
Comments

Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.

Max Length0
7. Practitioner.contained
Definition

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

Control0..*
TypeResource
Alternate Namesinline resources, anonymous resources, contained resources
Comments

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.

Max Length0
8. Practitioner.extension
Definition

May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Max Length0
9. Practitioner.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Control0..*
TypeExtension
Is Modifiertrue
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Max Length0
10. Practitioner.identifier
Definition

An identifier that applies to this person in this role.

NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..*
TypeIdentifier
Requirements

Often, specific identities are assigned for the agent.

Max Length0
11. Practitioner.active
Definition

Whether this practitioner's record is in active use.

Control0..1
Typeboolean
Requirements

Need to be able to mark a practitioner record as not to be used because it was created in error.

Comments

Default is true. If the practitioner is not in use by one organization, then it should mark the period on the PractitonerRole with an end date (even if they are active) as they may be active in another role.

Max Length0
Default Valuetrue
12. Practitioner.name
Definition

A human's name with the ability to identify parts and usage.

Control1..1
TypeHumanName(Shared Health HumanName)
Must Supporttrue
Requirements

The name(s) that a Practitioner is known by. Where there are multiple, the name that the practitioner is usually known as should be used in the display.

Comments

Conformance Rule: Set use = Professional; Alias is optional.

Max Length0
13. Practitioner.telecom
Definition

This segment provide methods of contacting the practitioner. Only numbers that have authorized to be disclosed by the practitioner should be included. For example, most practitioners do not authorize the disclosure of their cell phone number to pharmacies.

Control0..*
TypeContactPoint(Shared Health ContactPoint)
Must Supporttrue
Requirements

Need to know how to reach a practitioner independent to any roles the practitioner may have.

Comments

-

Max Length0
InvariantsDefined on this element
cpt-2: A system is required if a value is provided. (: value.empty() or system.exists())
14. Practitioner.address
Definition

Address(es) of the practitioner that are not role specific (typically home address). Work addresses are not typically entered in this property as they are usually role dependent.

Control0..*
TypeAddress
Requirements

The home/mailing address of the practitioner is often required for employee administration purposes, and also for some rostering services where the start point (practitioners home) can be used in calculations.

Comments

The PractitionerRole does not have an address value on it, as it is expected that the location property be used for this purpose (which has an address).

Max Length0
15. Practitioner.gender
Definition

Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes.

Control0..1
BindingThe codes SHALL be taken from AdministrativeGender The gender of a person used for administrative purposes.
Typecode
Requirements

Needed to address the person correctly.

Max Length0
16. Practitioner.birthDate
Definition

The date of birth for the practitioner.

Control0..1
Typedate
Requirements

Needed for identification.

Max Length0
17. Practitioner.photo
Definition

Image of the person.

Control0..*
TypeAttachment
Requirements

Many EHR systems have the capability to capture an image of patients and personnel. Fits with newer social media usage too.

Max Length0
18. Practitioner.practitionerRole
Definition

The list of roles/organizations that the practitioner is associated with.

Control1..1
TypeBackboneElement
Must Supporttrue
Comments

The address to be used for this PractitionerRole is in the referenced location (removing duplication across all the services provided at the location).

Max Length0
19. Practitioner.practitionerRole.id
Definition

unique id for the element within a resource (for internal references).

Control0..1
Typeid
Max Length0
20. Practitioner.practitionerRole.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Max Length0
21. Practitioner.practitionerRole.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Control0..*
TypeExtension
Is Modifiertrue
Alternate Namesextensions, user content, modifiers
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Max Length0
22. Practitioner.practitionerRole.organization
Definition

The organization where the Practitioner performs the roles associated.

Control0..1
TypeReference(Organization)
Max Length0
23. Practitioner.practitionerRole.role
Definition

Roles which this practitioner is authorized to perform for the organization.

Control1..1
BindingFor example codes, see PractitionerRole The role a person plays representing an organization
TypeCodeableConcept
Must Supporttrue
Requirements

Need to know what authority the practitioner has - what can they do?

Comments

A person may have more than one role. At least one role is required.

Max Length0
24. Practitioner.practitionerRole.role.id
Definition

unique id for the element within a resource (for internal references).

Control0..1
Typeid
Max Length0
25. Practitioner.practitionerRole.role.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Max Length0
26. Practitioner.practitionerRole.role.coding
Definition

A reference to a code defined by a terminology system.

Control0..*
TypeCoding
Requirements

Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.

Comments

Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labelled as UserSelected = true.

Max Length0
27. Practitioner.practitionerRole.role.text
Definition

A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

Control1..1
Typestring
Must Supporttrue
Requirements

The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

Comments

This indicates the 'title' of the non-clinician practitioner. E.g. 'Receptionist', 'clinic manager', etc.

Max Length0
28. Practitioner.practitionerRole.specialty
Definition

Specific specialty of the practitioner.

Control0..*
BindingFor example codes, see PractitionerSpecialty Specific specialty associated with the agency
TypeCodeableConcept
Max Length0
29. Practitioner.practitionerRole.identifier
Definition

Business Identifiers that are specific to a role/location.

NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..*
TypeIdentifier
Requirements

Some business identifiers are specific to a location and should be able to be associated.

Max Length0
30. Practitioner.practitionerRole.telecom
Definition

Contact details that are specific to the role/location/service.

Control0..*
TypeContactPoint
Requirements

Often practitioners have a dedicated line for each location (or service) that they work at, and need to be able to define separate contact details for each of these.

Max Length0
31. Practitioner.practitionerRole.period
Definition

The period during which the person is authorized to act as a practitioner in these role(s) for the organization.

Control0..1
TypePeriod
Requirements

Even after the agencies is revoked, the fact that it existed must still be recorded.

Max Length0
32. Practitioner.practitionerRole.location
Definition

The location(s) at which this practitioner provides care.

Control0..*
TypeReference(Location)
Max Length0
33. Practitioner.practitionerRole.healthcareService
Definition

The list of healthcare services that this worker provides for this role's Organization/Location(s).

Control0..*
TypeReference(HealthcareService)
Max Length0
34. Practitioner.qualification
Definition

Qualifications obtained by training and certification.

Control0..*
TypeBackboneElement
Max Length0
35. Practitioner.qualification.id
Definition

unique id for the element within a resource (for internal references).

Control0..1
Typeid
Max Length0
36. Practitioner.qualification.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Max Length0
37. Practitioner.qualification.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Control0..*
TypeExtension
Is Modifiertrue
Alternate Namesextensions, user content, modifiers
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Max Length0
38. Practitioner.qualification.identifier
Definition

An identifier that applies to this person's qualification in this role.

NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..*
TypeIdentifier
Requirements

Often, specific identities are assigned for the qualification.

Max Length0
39. Practitioner.qualification.code
Definition

Coded representation of the qualification.

Control1..1
BindingFor example codes, see ANZSCO -- Australian and New Zealand Standard Classification of Occupations, 2013, Version 1.2 Specific qualification the practitioner has to provide a service
TypeCodeableConcept
Max Length0
40. Practitioner.qualification.period
Definition

Period during which the qualification is valid.

Control0..1
TypePeriod
Requirements

Qualifications are often for a limited period of time, and can be revoked.

Max Length0
41. Practitioner.qualification.issuer
Definition

Organization that regulates and issues the qualification.

Control0..1
TypeReference(Organization)
Max Length0
42. Practitioner.communication
Definition

A language the practitioner is able to use in patient communication.

Control0..*
BindingThe codes SHALL be taken from http://tools.ietf.org/html/bcp47 A human language.
TypeCodeableConcept
Requirements

Knowing which language a practitioner speaks can help in facilitating communication with patients.

Comments

The structure aa-BB with this exact casing is one the most widely used notations for locale. However not all systems actually code this but instead have it as free text. Hence CodeableConcept instead of code as the data type.

Max Length0