DocumentHeader

COFE-Related-Person-1

COFE-Related-Person-1

RelatedPerson
Definition

Information about a person that is involved in the care for a patient, but who is not the target of healthcare, nor has a formal responsibility in the care process.

Control 0..*
Type RelatedPerson
Comments
RelatedPerson.identifier
Definition

Identifier for a person within a particular scope.

Control 0..*
Type Identifier
Requirements

People are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the patient. Examples are national person identifier and local identifier.

Comments
RelatedPerson.identifier.use
Definition

The purpose of this identifier.

Control 0..1
Binding

Identifies the purpose for this identifier, if known .

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

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

RelatedPerson.identifier.type
Definition

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

Control 0..1
Binding

A 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

Type CodeableConcept
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.

RelatedPerson.identifier.type.coding
Definition

A reference to a code defined by a terminology system.

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

RelatedPerson.identifier.type.coding.system
Definition

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

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

RelatedPerson.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.

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

RelatedPerson.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).

Control 0..1
Type Code
Requirements

Need to refer to a particular code in the system.

Comments
RelatedPerson.identifier.type.coding.display
Definition

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

Control 0..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
RelatedPerson.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).

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

RelatedPerson.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.

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.

RelatedPerson.identifier.system
Definition

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

Control 0..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
Example http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri
RelatedPerson.identifier.value
Definition

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

Control 0..1
Type String
Comments

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

Example 123456
RelatedPerson.identifier.period
Definition

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

Control 0..1
Type Period
Comments
RelatedPerson.identifier.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.

RelatedPerson.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.

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.

RelatedPerson.identifier.assigner
Definition

Organization that issued/manages the identifier.

Control 0..1
Type Organization
Comments

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

RelatedPerson.identifier.assigner.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.

Example RA9:SOUTH DEVON HEALTHCARE NHS TRUST
RelatedPerson.patient
Definition

The patient this person is related to.

Control 1..1
Requirements

We need to know which patient this RelatedPerson is related to.

Comments
RelatedPerson.patient.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.

RelatedPerson.patient.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.

RelatedPerson.relationship
Definition

recipientRoleCode uses a code from the RecipientNonClinicalPersonType vocabulary to describe the role of the non clinical person who is the recipient.

Control 1..1
Binding

A set of codes that can be used to indicate the relationship between a Patient and a Related Person.

The codes SHALL be taken from http://hl7.org/fhir/ValueSet/relatedperson-relationshiptype

Type CodeableConcept
Requirements

We need to know the relationship with the patient since it influences the interpretation of the information attributed to this person.

Comments
RelatedPerson.relationship.coding
Definition

A reference to a code defined by a terminology system.

Control 1..1
Binding

A set of codes that can be used to indicate the relationship between a Patient and a Related Person.

The codes SHALL be taken from http://hl7.org/fhir/ValueSet/relatedperson-relationshiptype

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.

RelatedPerson.relationship.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.

RelatedPerson.relationship.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
Type Code
Requirements

Need to refer to a particular code in the system.

Comments
RelatedPerson.relationship.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
RelatedPerson.name
Definition

A name associated with the person.

Control 0..1
Type HumanName
Requirements

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

Comments
RelatedPerson.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.

RelatedPerson.name.text
Definition

A full text representation of the name.

Control 0..1
Type String
Requirements

A renderable, unencoded form.

Comments

Can provide both a text representation and structured parts.

RelatedPerson.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.

RelatedPerson.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.

RelatedPerson.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
RelatedPerson.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
RelatedPerson.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
RelatedPerson.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.

RelatedPerson.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.

RelatedPerson.telecom
Definition

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

Control 0..*
Type ContactPoint
Requirements

People have (primary) ways to contact them in some way such as phone, email.

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.

RelatedPerson.telecom.system
Definition

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

Control 1..1 ?
Binding

Telecommunications form for contact point

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

Type Code
Comments
Example phone
RelatedPerson.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.

Example 0191 4021122
RelatedPerson.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-system

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.

Example work
RelatedPerson.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.

Control 0..1
Type PositiveInt
Comments

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

RelatedPerson.telecom.period
Definition

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

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

RelatedPerson.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.

RelatedPerson.gender
Definition

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

Control 0..1
Binding

The gender of a person used for administrative purposes.

The codes SHALL be taken from http://hl7.org/fhir/ValueSet/administrative-gender

Type Code
Requirements

Needed for identification of the person, in combination with (at least) name and birth date.

Comments
RelatedPerson.birthDate
Definition

The date on which the related person was born.

Control 0..1
Type Date
Comments
RelatedPerson.address
Definition

Address where the related person can be contacted or visited.

Control 0..*
Type Address
Requirements

Need to keep track where the related person can be contacted per postal mail or visited.

Comments
RelatedPerson.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
RelatedPerson.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
RelatedPerson.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
RelatedPerson.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
RelatedPerson.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
RelatedPerson.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
RelatedPerson.address.postalCode
Definition

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

Control 0..1
Type String
Aliases Zip
Comments
Example 9132
RelatedPerson.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.

RelatedPerson.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
RelatedPerson.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.

RelatedPerson.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.

RelatedPerson.period
Definition

The period of time that this relationship is considered to be valid. If there are no dates defined, then the interval is unknown.

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

RelatedPerson.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.