DocumentHeader

CareConnect-Patient-1

CareConnect-Patient-1

Patient
Definition

Demographics and other administrative information about a patient receiving care or other health-related services

Control 1..1
Type Patient
Aliases SubjectOfCare Client Resident
Comments
Patient.extension(registrationDetails)
Definition
Control 0..1
Type Extension
Comments
Patient.extension(birthTime)
Definition

The time of day that the Patient was born. This includes the date to ensure that the timezone information can be communicated effectively.

Control 0..1
Type Extension
Comments
Patient.extension(ethnicCategory)
Definition

Ethnicity of the patient

Control 0..1
Type Extension
Comments
Patient.extension(religiousAffiliation)
Definition

The religion as specified by the patient

Control 0..1
Type Extension
Comments
Patient.extension(organDonor)
Definition

An indicator that the patient is listed as an organ donor.

Control 0..1
Type Extension
Comments
Patient.extension(residentialStatus)
Definition

The residential status of the patient. For example if this patient is a UK resident.

Control 0..1
Type Extension
Comments
Patient.extension(treatmentCategory)
Definition

The treatment category for this patient. For example if this patient is entitled to free healthcare treatment.

Control 0..1
Type Extension
Comments
Patient.extension(nhsCommunication)
Definition

Communication preferences including a list of Languages which may be used for communication

Control 0..*
Type Extension
Comments
Patient.identifier(NHSNumber)
Definition

An NHS Number identifier for this patient

Control 0..1
Type Identifier
Requirements

Patients are almost always assigned specific numerical identifiers.

Comments
Patient.identifier.extension(nhsNumberVerificationStatus)
Definition

The verification/tracing status of the NHS number.

Control 0..1
Type Extension
Comments
Patient.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/nhs-number
Patient.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

Each NHS Number is made up of 10 digits shown in a 3-3-4 format.

Max Length 40
Example 9900002831
Patient.identifier(other)
Definition

An identifier for this patient.

Control 0..*
Type Identifier
Requirements

Patients are almost always assigned specific numerical identifiers.

Comments
Patient.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/nhs-number
Patient.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

Each NHS Number is made up of 10 digits shown in a 3-3-4 format.

Max Length 40
Example 9900002831
Patient.active
Definition

Whether this patient record is in active use

Control 0..1
Type Boolean
Is Modifier True
Requirements

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

Comments

Default is true. If a record is inactive, and linked to an active record, then future patient/record updates should occur on the other patient.

Default Value true
Patient.name(usual)
Definition

A name associated with the individual.

Control 0..1
Type HumanName
Requirements

Need to be able to track the patient by multiple names. Examples are your official name and a partner name.

Comments

A patient may have multiple names with different uses or applicable periods. For animals, the name is a "HumanName" in the sense that is assigned and used by humans and has the same patterns.

Patient.name.use
Definition

Identifies the purpose for this name

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

Example usual
Patient.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

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

Example Taylor
Patient.name.given
Definition

Given name

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

Example Sally
Patient.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..*
Type String
Comments
Example Mrs
Patient.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
Patient.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
Patient.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.

Patient.name(other)
Definition

A name associated with the individual.

Control 0..*
Type HumanName
Requirements

Need to be able to track the patient by multiple names. Examples are your official name and a partner name.

Comments

A patient may have multiple names with different uses or applicable periods. For animals, the name is a "HumanName" in the sense that is assigned and used by humans and has the same patterns.

Patient.name.use
Definition

Identifies the purpose for this name

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

Example usual
Patient.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

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

Example Taylor
Patient.name.given
Definition

Given name

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

Example Sally
Patient.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..*
Type String
Comments
Example Mrs
Patient.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
Patient.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
Patient.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.

Patient.telecom
Definition

A contact detail (e.g. a telephone number or an email address) by which the individual may be contacted..

Control 0..*
Type ContactPoint
Requirements

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

Comments

A Patient 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. The address may not go directly to the individual, but may reach another party that is able to proxy for the patient (i.e. home phone, or pet owner's phone).

Patient.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
Patient.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 out of band data such as extensions, or notes about use of the contact are sometimes included in the value.

Example 0113-245-1919
Patient.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/DSTU2/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.

Example home
Patient.telecom.period
Definition

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

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

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

Patient.gender
Definition

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

Control 1..1
Binding

The gender of a person used for administrative purposes.

The codes SHALL be taken from http://fhir.nhs.net/ValueSet/administrative-gender-1

Type Code
Requirements

Needed for identification of the individual, in combination with (at least) name and birth date. Gender of individual drives many clinical processes.

Comments

The gender may not match the biological sex as determined by genetics, or the individual's preferred identification.

Example female
Patient.birthDate
Definition

The date of birth for the patient

Control 1..1
Type Date
Requirements

Age of the individual drives many clinical processes.

Comments

At least an estimated year should be provided as a guess if the real date of birth is unknown.

Patient.deceased[x]
Definition

Indicates if the individual is deceased or not.

Control 0..1
Type Choice of:
Is Modifier True
Requirements

The fact that a patient is deceased influences the clinical process. Also, in human communication and relation management it is necessary to know whether the person is alive.

Comments

If there's no value in the instance it means there is no statement on whether or not the individual is deceased. Most systems will interpret the absence of a value as a sign of the person being alive.

Patient.address
Definition

Address details for the patient

Control 0..*
Type Address
Requirements

May need to keep track of patient addresses for contacting, billing or reporting requirements and also to help with identification.

Comments

Patient may have multiple addresses with different uses or applicable periods.

Patient.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
Patient.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
Patient.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 42 Grove Street, Overtown, West Yorkshire, LS21 1PF
Patient.address.line
Definition

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

Control 0..*
Type String
Requirements

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

Comments
Example 42, Grove Street
Patient.address.city
Definition

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

Control 0..1
Type String
Aliases Muncipality
Comments
Example Overtown
Patient.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 West Yorkshire
Patient.address.postalCode
Definition

A postal code designating a region defined by the postal service

Control 0..1
Type String
Aliases Zip
Comments
Example LS21 1PF
Patient.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.

Example GBR
Patient.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
Patient.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.

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

Patient.maritalStatus
Definition

This element contains a patient's most recent marital (civil) status.

Control 0..1
Binding

The domestic partnership status of a person.

The codes SHALL be taken from http://fhir.nhs.net/ValueSet/marital-status-1

Type CodeableConcept
Requirements

Most, if not all systems capture it.

Comments
Patient.maritalStatus.coding
Definition

A code taken from the marital status list of codes.

Control 0..1
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 V3 Core Principles for more information. Ordering of codings is undefined and SHALL not be used to infer meaning.

Patient.maritalStatus.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.

Fixed Value http://hl7.org/fhir/ValueSet/marital-status
Patient.maritalStatus.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.

Patient.maritalStatus.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
Example M
Patient.maritalStatus.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 Married
Patient.maritalStatus.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.

Patient.maritalStatus.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.

Patient.multipleBirth[x]
Definition

Indicates whether the patient is part of a multiple or indicates the actual birth order.

Control 0..1
Type Choice of:
Requirements

For disambiguation of multiple-birth children, especially relevant where the care provider doesn't meet the patient, such as labs.

Comments
Patient.contact
Definition

A contact party (e.g. guardian, partner, friend) for the patient.

Control 0..*
Type BackboneElement
Requirements

Need to track people you can contact about the patient.

Comments

Contact covers all kinds of contact parties: family members, business contacts, guardians, caregivers. Not applicable to register pedigree and family ties beyond use of having contact.

Patient.contact.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.

Patient.contact.relationship
Definition

The nature of the relationship between the patient and the contact person.

Control 0..*
Binding

The kind of relationship to the patient

The codes SHALL be taken from http://fhir.nhs.net/ValueSet/cda-person-relationship-type-1

Type CodeableConcept
Requirements

Used to determine which contact person is the most relevant to approach, depending on circumstances.

Comments
Patient.contact.relationship.coding
Definition

A code taken from the CDA Person Relationship Type list of codes.

Control 0..1
Binding

A code taken from the CDA Person Relationship Type list of codes.

The codes SHALL be taken from http://fhir.nhs.net/ValueSet/cda-person-relationship-type-1

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 V3 Core Principles for more information. Ordering of codings is undefined and SHALL not be used to infer meaning.

Patient.contact.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.

Fixed Value http://fhir.nhs.net/ValueSet/cda-person-relationship-type-1
Patient.contact.relationship.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.

Patient.contact.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
Example 43
Patient.contact.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
Example Daughter
Patient.contact.relationship.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.

Patient.contact.relationship.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.

Patient.contact.name
Definition

A name associated with the contact person.

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

Comments
Patient.contact.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.

Example usual
Patient.contact.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.

Patient.contact.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 1..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.

Example Taylor
Patient.contact.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.

Example Ann
Patient.contact.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..*
Type String
Comments
Example Miss
Patient.contact.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
Patient.contact.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

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

Patient.contact.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
Example phone
Patient.contact.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 0..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 0113-245-0909
Patient.contact.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.

Example home
Patient.contact.telecom.period
Definition

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

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

Patient.contact.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.

Patient.contact.address
Definition

Address for the contact person.

Control 0..1
Type Address
Requirements

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

Comments
Patient.contact.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
Patient.contact.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
Patient.contact.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 120, Grove Street, Overtown, West Yorkshire, LS21 1PT
Patient.contact.address.line
Definition

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

Control 0..*
Type String
Requirements

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

Comments
Example 120, Grove Street
Patient.contact.address.city
Definition

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

Control 0..1
Type String
Aliases Muncipality
Comments
Example Overtown
Patient.contact.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 West Yorkshire
Patient.contact.address.postalCode
Definition

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

Control 0..1
Type String
Aliases Zip
Comments
Example LS21 1PT
Patient.contact.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.

Example GBR
Patient.contact.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
Patient.contact.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.

Patient.contact.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.

Patient.contact.gender
Definition

Administrative Gender - the gender that the contact 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://fhir.nhs.net/ValueSet/administrative-gender-1

Type Code
Requirements

Needed to address the person correctly.

Comments
Example female
Patient.contact.organization
Definition

Organization on behalf of which the contact is acting or for which the contact is working

Control 0..1 ?
Requirements

For guardians or business related contacts, the organization is relevant.

Comments
Patient.contact.organization.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 0..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.

Patient.contact.organization.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.

Patient.contact.period
Definition

The period during which this contact person or organization is valid to be contacted relating to this patient.

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

Patient.contact.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.

Patient.careProvider
Definition

Patient's nominated care provider or GP details.

Control 0..*
Type Choice of:
Comments

This may be the primary care provider (in a GP context), or it may be a patient nominated care manager in a community/disablity setting, or even organization that will provide people to perform the care provider roles. This is not to be used to record Care Teams, these should be recorded on either the CarePlan or EpisodeOfCare resources.

Patient.managingOrganization
Definition

Organization that is the custodian of the patient record.

Control 0..1
Requirements

Need to know who recognizes this patient record, manages and updates it.

Comments

There is only one managing organization for a specific patient record. Other organizations will have their own Patient record, and may use the Link property to join the records together (or a Person resource which can include confidence ratings for the association).

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

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

Patient.link
Definition

Link to another patient resource that concerns the same actual patient.

Control 0..*
Type BackboneElement
Requirements

There are multiple usecases: * Duplicate patient records due to the clerical errors associated with the difficulties of identifying humans consistently, and * Distribution of patient information across multiple servers.

Comments

There is no assumption that linked patient records have mutual links.

Patient.link.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.

Patient.link.other
Definition

The other patient resource that the link refers to.

Control 1..1
Is Modifier True
Comments
Patient.link.other.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 0..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.

Patient.link.other.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.

Patient.link.type
Definition

The type of link between this patient resource and another patient resource.

Control 1..1
Binding

The type of link between this patient resource and another patient resource.

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

Type Code
Is Modifier True
Comments