EOLDocument

COFE-DocumentParticipantUniversal-1

COFE-DocumentParticipantUniversal-1

Practitioner
Definition

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

Control 0..*
Type Practitioner
Comments

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

Practitioner.extension(Participant Type)
Definition

Optional Extensions Element - found in all resources.

Control 0..1
Type Extension
Comments
Practitioner.extension(Participant Function Code)
Definition

Optional Extensions Element - found in all resources.

Control 0..1
Type Extension
Comments
Practitioner.extension(Role Class Associative)
Definition

Optional Extensions Element - found in all resources.

Control 0..1
Type Extension
Comments
Practitioner.identifier(SDS Identifier)
Definition

An identifier that applies to this person in this role.

Control 0..1
Type Identifier
Requirements

Often, specific identities are assigned for the agent.

Comments
Practitioner.identifier.system
Definition

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

Control 1..1
Type Uri
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
Fixed Value http://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.

Control 1..1
Type String
Comments

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

Example 200009876204
Practitioner.identifier(SDS Role Profile Identifier)
Definition

An identifier that applies to this person in this role.

Control 0..1
Type Identifier
Requirements

Often, specific identities are assigned for the agent.

Comments
Practitioner.identifier.system
Definition

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

Control 1..1
Type Uri
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
Fixed Value http://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.

Control 1..1
Type String
Comments

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

Example 200009876204
Practitioner.identifier(Alternative Identifier)
Definition

An identifier that applies to this person in this role.

Control 0..1
Type Identifier
Requirements

Often, specific identities are assigned for the agent.

Comments
Practitioner.identifier.system
Definition

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

Control 1..1
Type Uri
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
Fixed Value http://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.

Control 1..1
Type String
Comments

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

Example 200009876204
Practitioner.name
Definition

A name associated with the person.

Control 1..1
Type HumanName
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.

Control 0..1
Binding

The use of a human name

The codes SHALL be taken from http://hl7.org/fhir/ValueSet/name-use

Type Code
Is Modifier True
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.

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.

Control 0..1
Type String
Aliases surname
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.

Practitioner.name.given
Definition

Given name.

Control 0..*
Type String
Aliases first 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.

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.

Control 0..1
Type String
Comments
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.

Control 0..*
Type String
Comments
Practitioner.name.period
Definition

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

Control 0..1
Type Period
Requirements

Allows names to be placed in historical context.

Comments
Practitioner.name.period.start
Definition

The start of the period. The boundary is inclusive.

Control 0..1 ?
Type DateTime
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.

Control 0..1 ?
Type DateTime
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.

Control 0..*
Type ContactPoint
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.

Control 0..1 ?
Binding

Telecommunications form for contact point

The codes SHALL be taken from http://hl7.org/fhir/ValueSet/contact-point-system

Type Code
Comments
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).

Control 1..1
Type String
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.

Practitioner.telecom.use
Definition

Identifies the purpose for the contact point.

Control 0..1
Binding

Use of contact point

The codes SHALL be taken from http://hl7.org/fhir/ValueSet/contact-point-use

Type Code
Is Modifier True
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.

Practitioner.telecom.period
Definition

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

Control 0..1
Type Period
Comments
Practitioner.telecom.period.start
Definition

The start of the period. The boundary is inclusive.

Control 0..1 ?
Type DateTime
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.

Control 0..1 ?
Type DateTime
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.address
Definition

The postal address where the practitioner can be found or visited or to which mail can be delivered.

Control 0..1
Type Address
Requirements

Need to keep track where the practitioner can found during work or for directing mail.

Comments
Practitioner.address.use
Definition

The purpose of this address.

Control 0..1
Binding

The use of an address

The codes SHALL be taken from http://hl7.org/fhir/ValueSet/address-use

Type Code
Is Modifier True
Requirements

Allows an appropriate address to be chosen from a list of many.

Comments

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

Example home
Practitioner.address.type
Definition

Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both.

Control 0..1
Binding

The type of an address (physical / postal)

The codes SHALL be taken from http://hl7.org/fhir/ValueSet/address-type

Type Code
Comments
Example both
Practitioner.address.text
Definition

A full text representation of the address.

Control 0..1
Type String
Requirements

A renderable, unencoded form.

Comments

Can provide both a text representation and parts.

Example 137 Nowhere Street, Erewhon 9132
Practitioner.address.line
Definition

This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information.

Control 0..*
Type String
Requirements

home | work | temp | old - purpose of this address.

Comments
Example 137 Nowhere Street
Practitioner.address.city
Definition

The name of the city, town, village or other community or delivery center.

Control 0..1
Type String
Aliases Municpality
Comments
Example Erewhon
Practitioner.address.district
Definition

The name of the administrative area (county).

Control 0..1
Type String
Aliases County
Comments

District is sometimes known as county, but in some regions 'county' in used in place of city (municipality), so county name should be conveyed in city instead.

Example Madison
Practitioner.address.postalCode
Definition

A postal code designating a region defined by the postal service.

Control 0..1
Type String
Aliases Zip
Comments
Example 9132
Practitioner.address.country
Definition

Country - a nation as commonly understood or generally accepted.

Control 0..1
Type String
Comments

ISO 3166 3 letter codes can be used in place of a full country name.

Practitioner.address.period
Definition

Time period when address was/is in use.

Control 0..1
Type Period
Requirements

Allows addresses to be placed in historical context.

Comments
Example Hl7.Fhir.Model.Period
Practitioner.address.period.start
Definition

The start of the period. The boundary is inclusive.

Control 0..1 ?
Type DateTime
Comments

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

Practitioner.address.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.

Control 0..1 ?
Type DateTime
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.practitionerRole
Definition

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

Control 0..1
Type BackboneElement
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.

Control 0..*
Type Extension
Is Modifier True
Aliases extensions, 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.

Control 0..1
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.

Control 1..1 ?
Type String
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.managingOrganization.display
Definition

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

Control 0..1
Type String
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.practitionerRole.role
Definition

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

Control 0..1
Binding

The role a person plays representing an organization

For example codes, see http://snomed.info/sct

; other codes may be used where these codes are not suitable
Type CodeableConcept
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.

Control 0..1
Binding

Code defined by SnomedCT

For example codes, see http://snomed.info/sct

; other codes may be used where these codes are not suitable
Type Coding
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.

Control 1..1
Type Uri
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.

Example http://snomed.info/sct
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).

Control 1..1
Binding

Code defined by SnomedCT

For example codes, see http://snomed.info/sct

; other codes may be used where these codes are not suitable
Type Code
Requirements

Need to refer to a particular code in the system.

Comments
Example 158997000
Practitioner.practitionerRole.role.coding.display
Definition

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

Control 1..1
Type String
Requirements

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

Comments
Example District nurse
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.

Control 0..1
Type String
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.