Diagnostic Data Services

DDS-Report-Health-Care-Professional-1-0

DDS-Report-Health-Care-Professional-1-0

Practitioner
Definition

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

Control0..*
TypePractitioner
Comments

Note that a cab driver no longer fits the bill. You probably would be interested in the organization rather than the individual?

Practitioner.identifier
Definition

An identifier that applies to this person in this role.

Control0..*
TypeIdentifier
Requirements

Often, specific identities are assigned for the agent.

Comments
Practitioner.identifier.use
Definition

The purpose of this identifier.

Control0..1
BindingIdentifies the purpose for this identifier, if known.
The codes SHALL be taken from http://hl7.org/fhir/ValueSet/identifier-use
TypeCode
Is ModifierTrue
Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Comments

This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Exampleofficial
Practitioner.identifier.type
Definition

A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

Control0..1
BindingA coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
The codes SHALL be taken from the following if appropriate, otherwise an alternate coding may be included instead. http://hl7.org/fhir/ValueSet/identifier-type
TypeCodeableConcept
Requirements

Allows users to make use of identifiers when the identifier system is not known.

Comments

This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

Practitioner.identifier.type.coding
Definition

A reference to a code defined by a terminology system.

Control0..1
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.

Practitioner.identifier.type.coding.system
Definition

The identification of the code system that defines the meaning of the symbol in the code.

Control1..1
TypeUri
Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously.

Practitioner.identifier.type.coding.version
Definition

The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

Control0..1
TypeString
Comments

Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

Practitioner.identifier.type.coding.code
Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Control1..1
TypeCode
Requirements

Need to refer to a particular code in the system.

Comments
Practitioner.identifier.type.coding.display
Definition

A representation of the meaning of the code in the system, following the rules of the system.

Control1..1
TypeString
Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Comments
Practitioner.identifier.type.coding.userSelected
Definition

Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays).

Control0..1
TypeBoolean
Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

Practitioner.identifier.type.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.

Control0..1
TypeString
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

Very often the text is the same as a displayName of one of the codings.

Practitioner.identifier.system
Definition

Establishes the namespace in which set of possible id values is unique.

Control1..1
TypeUri
Requirements

There are many sequences of identifiers. To perform matching, we need to know what sequence we're dealing with. The system identifies a particular sequence or set of unique identifiers.

Comments
Examplehttp://fhir.nhs.net/Id/sds-user-id
Practitioner.identifier.value
Definition

The portion of the identifier typically displayed to the user and which is unique within the context of the system.

Control1..1
TypeString
Comments

If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986.

Example9900000276
Practitioner.identifier.period
Definition

Time period during which identifier is/was valid for use.

Control0..1
TypePeriod
Comments
Practitioner.identifier.period.start
Definition

The start of the period. The boundary is inclusive.

Control1..1 ?
TypeDateTime
Comments

If the low element is missing, the meaning is that the low boundary is not known.

Practitioner.identifier.period.end
Definition

The end of the period. If the end of the period is missing, it means that the period is ongoing. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.

Control0..1 ?
TypeDateTime
Comments

The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has a end value of 2012-02-03.

Practitioner.identifier.assigner
Definition

Organization that issued/manages the identifier.

Control0..1
TypeOrganization
Comments

The reference may be just a text description of the assigner.

Practitioner.identifier.assigner.reference
Definition

A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

Control1..1 ?
TypeString
Comments

Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

Practitioner.identifier.assigner.display
Definition

Plain text narrative that identifies the resource in addition to the resource reference.

Control0..1
TypeString
Comments

This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

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.

Default Valuetrue
Exampletrue
Practitioner.name
Definition

A name associated with the person.

Control0..1
TypeHumanName
Requirements

Contact persons need to be identified by name, but it is uncommon to need details about multiple other names for that person.

Comments
Practitioner.name.use
Definition

Identifies the purpose for this name.

Control0..1
BindingThe use of a human name
The codes SHALL be taken from http://hl7.org/fhir/ValueSet/name-use
TypeCode
Is ModifierTrue
Requirements

Allows the appropriate name for a particular context of use to be selected from among a set of names.

Comments

This is labeled as "Is Modifier" because applications should not mistake a temporary or old name etc.for a current/permanent one. Applications can assume that a name is current unless it explicitly says that it is temporary or old.

Exampleofficial
Practitioner.name.text
Definition

A full text representation of the name.

Control0..1
TypeString
Requirements

A renderable, unencoded form.

Comments

Can provide both a text representation and structured parts.

Practitioner.name.family
Definition

The part of a name that links to the genealogy. In some cultures (e.g. Eritrea) the family name of a son is the first name of his father.

Control0..1
TypeString
Aliasessurname
Comments

For family name, hyphenated names such as "Smith-Jones" are a single name, but names with spaces such as "Smith Jones" are broken into multiple parts.

ExampleJones
Practitioner.name.given
Definition

Given name.

Control0..1
TypeString
Aliasesfirst name, middle name
Comments

If only initials are recorded, they may be used in place of the full name. Not called "first name" since given names do not always come first.

ExampleTim
Practitioner.name.prefix
Definition

Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the start of the name.

Control0..*
TypeString
Comments
ExampleDr
Practitioner.name.suffix
Definition

Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the end of the name.

Control0..*
TypeString
Comments
Practitioner.name.period
Definition

Indicates the period of time when this name was valid for the named person.

Control0..1
TypePeriod
Requirements

Allows names to be placed in historical context.

Comments
Practitioner.name.period.start
Definition

The start of the period. The boundary is inclusive.

Control1..1 ?
TypeDateTime
Comments

If the low element is missing, the meaning is that the low boundary is not known.

Practitioner.name.period.end
Definition

The end of the period. If the end of the period is missing, it means that the period is ongoing. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.

Control0..1 ?
TypeDateTime
Comments

The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has a end value of 2012-02-03.

Practitioner.telecom
Definition

A contact detail for the practitioner, e.g. a telephone number or an email address.

Control0..*
TypeContactPoint
Requirements

Need to know how to reach a practitioner.

Comments

Person may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently, and also to help with identification.

Practitioner.telecom.system
Definition

Telecommunications form for contact point - what communications system is required to make use of the contact.

Control1..1 ?
BindingTelecommunications form for contact point
The codes SHALL be taken from http://hl7.org/fhir/ValueSet/contact-point-system
TypeCode
Comments
Examplephone
Practitioner.telecom.value
Definition

The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address).

Control1..1
TypeString
Requirements

Need to support legacy numbers that are not in a tightly controlled format.

Comments

Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value.

Example07887351362
Practitioner.telecom.use
Definition

Identifies the purpose for the contact point.

Control0..1
BindingUse of contact point
The codes SHALL be taken from http://hl7.org/fhir/ValueSet/contact-point-use
TypeCode
Is ModifierTrue
Requirements

Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose.

Comments

This is labeled as "Is Modifier" because applications should not mistake a temporary or old contact etc.for a current/permanent one. Applications can assume that a contact is current unless it explicitly says that it is temporary or old.

Examplemobile
Practitioner.telecom.rank
Definition

Specifies a preferred order in which to use a set of contacts. Contacts are ranked with lower values coming before higher values.

Control0..1
TypePositiveInt
Comments

Note that rank does not necessarily follow the order in which the contacts are represented in the instance.

Practitioner.telecom.period
Definition

Time period when the contact point was/is in use.

Control0..1
TypePeriod
Comments
Practitioner.telecom.period.start
Definition

The start of the period. The boundary is inclusive.

Control1..1 ?
TypeDateTime
Comments

If the low element is missing, the meaning is that the low boundary is not known.

Practitioner.telecom.period.end
Definition

The end of the period. If the end of the period is missing, it means that the period is ongoing. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.

Control0..1 ?
TypeDateTime
Comments

The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has a end value of 2012-02-03.

Practitioner.gender
Definition

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

Control0..1
BindingThe gender of a person used for administrative purposes.
The codes SHALL be taken from http://fhir.nhs.net/ValueSet/administrative-gender-1-0
TypeCode
Requirements

Needed to address the person correctly.

Comments
Examplemale
Practitioner.practitionerRole
Definition

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

Control0..*
TypeBackboneElement
Comments
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
Aliasesextensions, 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.

Practitioner.practitionerRole.managingOrganization
Definition

The organization where the Practitioner performs the roles associated.

Control0..1
TypeOrganization
Comments
Practitioner.practitionerRole.managingOrganization.reference
Definition

A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

Control1..1 ?
TypeString
Comments

Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

ExampleOrganization/78D64BB3-B5B2-450B-AEB7-D9035EBC711D
Practitioner.practitionerRole.managingOrganization.display
Definition

Plain text narrative that identifies the resource in addition to the resource reference.

Control0..1
TypeString
Comments

This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

ExampleMGP Medical Centre
Practitioner.practitionerRole.role
Definition

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

Control0..1
BindingThe role a person plays representing an organization. Valueset under discussion.
For example codes, see http://snomed.info/sct; other codes may be used where these codes are not suitable
TypeCodeableConcept
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.

Practitioner.practitionerRole.role.coding
Definition

A reference to a code defined by a terminology system.

Control0..1
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.

Practitioner.practitionerRole.role.coding.system
Definition

The identification of the code system that defines the meaning of the symbol in the code.

Control1..1
TypeUri
Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously.

Fixed Valuehttp://snomed.info/sct
Practitioner.practitionerRole.role.coding.version
Definition

The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

Control0..1
TypeString
Comments

Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

Practitioner.practitionerRole.role.coding.code
Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Control1..1
TypeCode
Requirements

Need to refer to a particular code in the system.

Comments
Example24841000000106
Practitioner.practitionerRole.role.coding.display
Definition

A representation of the meaning of the code in the system, following the rules of the system.

Control1..1
TypeString
Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Comments
ExampleUsual general practitioner
Practitioner.practitionerRole.role.coding.userSelected
Definition

Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays).

Control0..1
TypeBoolean
Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

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.

Control0..1
TypeString
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

Very often the text is the same as a displayName of one of the codings.

Practitioner.practitionerRole.specialty
Definition

Specific specialty of the practitioner.

Control0..*
BindingSpecific specialty associated with the agency
For example codes, see http://hl7.org/fhir/ValueSet/practitioner-specialty; other codes may be used where these codes are not suitable
TypeCodeableConcept
Comments
Practitioner.practitionerRole.specialty.coding
Definition

A reference to a code defined by a terminology system.

Control0..1
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.

Practitioner.practitionerRole.specialty.coding.system
Definition

The identification of the code system that defines the meaning of the symbol in the code.

Control1..1
TypeUri
Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously.

Examplehttp://hl7.org/fhir/ValueSet/practitioner-specialty
Practitioner.practitionerRole.specialty.coding.version
Definition

The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

Control0..1
TypeString
Comments

Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

Practitioner.practitionerRole.specialty.coding.code
Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Control1..1
TypeCode
Requirements

Need to refer to a particular code in the system.

Comments
Practitioner.practitionerRole.specialty.coding.display
Definition

A representation of the meaning of the code in the system, following the rules of the system.

Control1..1
TypeString
Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Comments
Practitioner.practitionerRole.specialty.coding.userSelected
Definition

Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays).

Control0..1
TypeBoolean
Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

Practitioner.practitionerRole.specialty.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.

Control0..1
TypeString
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

Very often the text is the same as a displayName of one of the codings.

ExampleDr. Jones is a registered GP and also a Hospital Consultant Microbiologist.
Practitioner.practitionerRole.healthcareService
Definition

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

Control0..*
TypeHealthcareService
Comments
Practitioner.practitionerRole.healthcareService.reference
Definition

A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

Control1..1 ?
TypeString
Comments

Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

Practitioner.practitionerRole.healthcareService.display
Definition

Plain text narrative that identifies the resource in addition to the resource reference.

Control0..1
TypeString
Comments

This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.