Interweave Implementation Guide
0.1.0 - ci-build

Interweave Implementation Guide - Local Development build (v0.1.0). See the Directory of published versions

Resource Profile: InterweavePatient - Detailed Descriptions

Active as of 2024-03-08

Definitions for the Interweave-Patient resource profile.

Guidance on how to interpret the contents of this table can be found here.

1. Patient
2. Patient.id
Must Supporttrue
3. Patient.meta
Control0..?
4. Patient.meta.versionId
Control0..?
Must Supporttrue
5. Patient.meta.lastUpdated
Control0..?
Must Supporttrue
6. Patient.meta.profile
Control0..?
Must Supporttrue
7. Patient.meta.security
Control0..?
8. Patient.meta.tag
Control0..?
SlicingThis element introduces a set of slices on Patient.meta.tag. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ system
9. Patient.meta.tag:Source
SliceNameSource
Control0..1
Must Supporttrue
10. Patient.meta.tag:Source.system
Control1..?
Fixed Valuehttps://yhcr.nhs.uk/Source
11. Patient.meta.tag:Source.code
Control1..?
Must Supporttrue
12. Patient.meta.tag:Source.display
Control1..?
Must Supporttrue
13. Patient.meta.tag:Provenance
SliceNameProvenance
Control0..1
Must Supporttrue
14. Patient.meta.tag:Provenance.system
Control1..?
Fixed Valuehttps://yhcr.nhs.uk/Provenance
15. Patient.meta.tag:Provenance.code
Control1..?
Must Supporttrue
16. Patient.meta.tag:Provenance.display
Control1..?
Must Supporttrue
17. Patient.implicitRules
18. Patient.language
19. Patient.text
20. Patient.extension:ethnicCategory
SliceNameethnicCategory
21. Patient.extension:patient-cadavericDonor
SliceNamepatient-cadavericDonor
22. Patient.extension:treatmentCategory
SliceNametreatmentCategory
23. Patient.extension:nhsCommunication
SliceNamenhsCommunication
Must Supporttrue
24. Patient.extension:nhsCommunication.extension:modeOfCommunication
SliceNamemodeOfCommunication
Control0..?
25. Patient.extension:nhsCommunication.extension:communicationProficiency
SliceNamecommunicationProficiency
Control0..?
26. Patient.extension:birthPlace
SliceNamebirthPlace
27. Patient.extension:nominatedPharmacy
SliceNamenominatedPharmacy
28. Patient.extension:deathNotificationStatus
SliceNamedeathNotificationStatus
29. Patient.extension:sexualOrientation
SliceNamesexualOrientation
Control0..1
TypeExtension(ExtensionInterweaveSexualOrientation) (Extension Type: CodeableConcept)
30. Patient.identifier
NoteThis is a business identifier, not a resource identifier (see discussion)
Control10..*
31. Patient.identifier:nhsNumber
SliceNamenhsNumber
NoteThis is a business identifier, not a resource identifier (see discussion)
Control10..1
Must Supporttrue
32. Patient.identifier:nhsNumber.extension:nhsNumberVerificationStatus
SliceNamenhsNumberVerificationStatus
33. Patient.identifier:nhsNumber.extension:nhsNumberVerificationStatus.value[x]:valueCodeableConcept
SliceNamevalueCodeableConcept
Control0..?
TypeCodeableConcept
[x] NoteSee Choice of Data Types for further information about how to use [x]
Fixed Value<valueCodeableConcept xmlns="http://hl7.org/fhir">
  <coding>
    <system value="https://fhir.hl7.org.uk/STU3/CodeSystem/CareConnect-NHSNumberVerificationStatus-1"/>
    <code value="01"/>
    <display value="Number present and verified"/>
  </coding>
</valueCodeableConcept>
34. Patient.active
Must Supporttrue
35. Patient.name:official
SliceNameofficial
Must Supporttrue
36. Patient.name:official.use
Must Supporttrue
37. Patient.name:official.text
38. Patient.name:official.family
Must Supporttrue
39. Patient.name:official.given
Control10..*
Must Supporttrue
40. Patient.name:official.prefix
Must Supporttrue
41. Patient.name:official.suffix
Must Supporttrue
42. Patient.telecom
Must Supporttrue
43. Patient.telecom.system
Must Supporttrue
44. Patient.telecom.value
Must Supporttrue
45. Patient.telecom.use
Must Supporttrue
46. Patient.gender
Must Supporttrue
47. Patient.birthDate
Control10..1
Must Supporttrue
48. Patient.deceased[x]
[x] NoteSee Choice of Data Types for further information about how to use [x]
49. Patient.address
Must Supporttrue
50. Patient.address.use
Must Supporttrue
51. Patient.address.text
52. Patient.address.line
Must Supporttrue
53. Patient.address.city
Must Supporttrue
54. Patient.address.district
Must Supporttrue
55. Patient.address.postalCode
Must Supporttrue
56. Patient.photo
Control0..0*
57. Patient.contact
Must Supporttrue
58. Patient.contact.relationship
Must Supporttrue
59. Patient.contact.relationship.coding
Control0..?
60. Patient.contact.relationship.coding.system
Control1..?
61. Patient.contact.relationship.coding.code
Control1..?
62. Patient.contact.relationship.coding.display
Control1..?
63. Patient.contact.name
Must Supporttrue
64. Patient.contact.name.text
65. Patient.contact.telecom
Must Supporttrue
66. Patient.contact.address
Control0..?
67. Patient.contact.address.text
68. Patient.generalPractitioner
69. Patient.managingOrganization
70. Patient.link

Guidance on how to interpret the contents of this table can be found here.

1. Patient
Definition

Demographics and other administrative information about an individual or animal receiving care or other health-related services.

Control0..*
Alternate NamesSubjectOfCare Client Resident
InvariantsDefined on this element
dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative (: contained.text.empty())
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (: contained.contained.empty())
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource (: contained.where(('#'+id in %resource.descendants().reference).not()).empty())
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())
2. Patient.id
Definition

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

Control0..1
Typeid
Must Supporttrue
Summarytrue
Comments

The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

3. Patient.meta
Definition

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

Control0..1
TypeMeta
Summarytrue
4. Patient.meta.versionId
Definition

The version specific identifier, as it appears in the version portion of the URL. This values changes when the resource is created, updated, or deleted.

Control0..1
Typeid
Must Supporttrue
Summarytrue
Comments

The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes.

5. Patient.meta.lastUpdated
Definition

When the resource last changed - e.g. when the version changed.

Control0..1
Typeinstant
Must Supporttrue
Summarytrue
Comments

This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant.

6. Patient.meta.profile
Definition

A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url.

Control0..*
Typeuri
Must Supporttrue
Summarytrue
Comments

It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set.

7. Patient.meta.security
Definition

Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.

Control0..*
BindingThe codes SHALL be taken from All Security Labels; other codes may be used where these codes are not suitable

Security Labels from the Healthcare Privacy and Security Classification System.

TypeCoding
Summarytrue
Comments

The security labels can be updated without changing the stated version of the resource The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored.

8. Patient.meta.tag
Definition

Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.

Control0..*
BindingFor example codes, see Common Tags

Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"

TypeCoding
Summarytrue
Comments

The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored.

SlicingThis element introduces a set of slices on Patient.meta.tag. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ system
9. Patient.meta.tag:Source
SliceNameSource
Definition

Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.

Control0..1*
BindingFor example codes, see Common Tags

Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"

TypeCoding
Must Supporttrue
Summarytrue
Comments

The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored.

10. Patient.meta.tag:Source.system
Definition

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

Control10..1
Typeuri
Summarytrue
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 Valuehttps://yhcr.nhs.uk/Source
11. Patient.meta.tag:Source.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).

Control10..1
Typecode
Must Supporttrue
Summarytrue
Requirements

Need to refer to a particular code in the system.

12. Patient.meta.tag:Source.display
Definition

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

Control10..1
Typestring
Must Supporttrue
Summarytrue
Requirements

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

13. Patient.meta.tag:Provenance
SliceNameProvenance
Definition

Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.

Control0..1*
BindingFor example codes, see Common Tags

Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"

TypeCoding
Must Supporttrue
Summarytrue
Comments

The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored.

14. Patient.meta.tag:Provenance.system
Definition

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

Control10..1
Typeuri
Summarytrue
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 Valuehttps://yhcr.nhs.uk/Provenance
15. Patient.meta.tag:Provenance.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).

Control10..1
Typecode
Must Supporttrue
Summarytrue
Requirements

Need to refer to a particular code in the system.

16. Patient.meta.tag:Provenance.display
Definition

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

Control10..1
Typestring
Must Supporttrue
Summarytrue
Requirements

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

17. Patient.implicitRules
Definition

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

Control0..1
Typeuri
Is Modifiertrue
Summarytrue
Comments

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

This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.

18. Patient.language
Definition

The base language in which the resource is written.

Control0..1
BindingThe codes SHALL be taken from Common Languages; other codes may be used where these codes are not suitable

A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
Typecode
Comments

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

19. Patient.text
Definition

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

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

Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded in formation is added later.

20. Patient.extension:ethnicCategory
SliceNameethnicCategory
Definition

The ethnicity of the subject.

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(Extension-CareConnect-EthnicCategory-1) (Extension Type: CodeableConcept)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
21. Patient.extension:religiousAffiliation
SliceNamereligiousAffiliation
Definition

The religious affiliation of the subject.

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(Extension-CareConnect-ReligiousAffiliation-1) (Extension Type: CodeableConcept)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
22. Patient.extension:patient-cadavericDonor
SliceNamepatient-cadavericDonor
Definition

Flag indicating whether the patient authorized the donation of body parts after death.

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(cadavericDonor) (Extension Type: boolean)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
23. Patient.extension:residentialStatus
SliceNameresidentialStatus
Definition

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

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(Extension-CareConnect-ResidentialStatus-1) (Extension Type: CodeableConcept)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
24. Patient.extension:treatmentCategory
SliceNametreatmentCategory
Definition

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

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(Extension-CareConnect-TreatmentCategory-1) (Extension Type: CodeableConcept)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
25. Patient.extension:nhsCommunication
SliceNamenhsCommunication
Definition

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

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

Control This element is affected by the following invariants: ele-1
TypeExtension(Extension-CareConnect-NHSCommunication-1) (Complex Extension)
Must Supporttrue
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
26. Patient.extension:nhsCommunication.extension:language
SliceNamelanguage
Definition

Languages which may be used for communication.

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

Control10..1*
TypeExtension
Alternate Namesextensions, user content
Comments

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

27. Patient.extension:nhsCommunication.extension:language.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Control1..1
Typeuri
XML RepresentationIn the XML format, this property is represented as an attribute.
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Fixed Valuelanguage
28. Patient.extension:nhsCommunication.extension:language.value[x]
Definition

Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

Control10..1
TypeChoice of: CodeableConcept, date, dateTime, Meta, code, string, Address, Attachment, integer, oid, Count, instant, ContactPoint, HumanName, Money, Identifier, Coding, markdown, SampledData, Ratio, id, positiveInt, Age, Distance, Reference, Period, Quantity, Duration, Range, uri, Annotation, boolean, base64Binary, Signature, unsignedInt, time, Timing, decimal
[x] NoteSee Choice of Data Types for further information about how to use [x]
SlicingThis element introduces a set of slices on Patient.extension.extension.value[x]. The slices are unordered and Closed, and can be differentiated using the following discriminators:
  • type @ $this
29. Patient.extension:nhsCommunication.extension:language.value[x]:valueCodeableConcept
SliceNamevalueCodeableConcept
Definition

Languages which may be used for communication.

Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

Control10..1
BindingThe codes SHALL be taken from Care Connect Human LanguageFor codes, see (unbound) Human Languag
TypeChoice of: CodeableConcept, date, dateTime, Meta, code, string, Address, Attachment, integer, oid, Count, instant, ContactPoint, HumanName, Money, Identifier, Coding, markdown, SampledData, Ratio, id, positiveInt, Age, Distance, Reference, Period, Quantity, Duration, Range, uri, Annotation, boolean, base64Binary, Signature, unsignedInt, time, Timing, decimal
[x] NoteSee Choice of Data Types for further information about how to use [x]
30. Patient.extension:nhsCommunication.extension:preferred
SliceNamepreferred
Definition

An Extension

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

Control0..1*
TypeExtension
Alternate Namesextensions, user content
Comments

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

31. Patient.extension:nhsCommunication.extension:preferred.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Control1..1
Typeuri
XML RepresentationIn the XML format, this property is represented as an attribute.
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Fixed Valuepreferred
32. Patient.extension:nhsCommunication.extension:preferred.value[x]
Definition

Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

Control10..1
TypeChoice of: boolean, date, dateTime, Meta, code, string, Address, Attachment, integer, oid, Count, instant, ContactPoint, HumanName, Money, Identifier, Coding, markdown, SampledData, Ratio, id, positiveInt, Age, Distance, Reference, Period, Quantity, Duration, Range, uri, Annotation, base64Binary, Signature, unsignedInt, time, Timing, decimal, CodeableConcept
[x] NoteSee Choice of Data Types for further information about how to use [x]
SlicingThis element introduces a set of slices on Patient.extension.extension.value[x]. The slices are unordered and Closed, and can be differentiated using the following discriminators:
  • type @ $this
33. Patient.extension:nhsCommunication.extension:preferred.value[x]:valueBoolean
SliceNamevalueBoolean
Definition

Indicates whether or not this language is preferred (over other languages up a certain level)

Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

Control10..1
TypeChoice of: boolean, date, dateTime, Meta, code, string, Address, Attachment, integer, oid, Count, instant, ContactPoint, HumanName, Money, Identifier, Coding, markdown, SampledData, Ratio, id, positiveInt, Age, Distance, Reference, Period, Quantity, Duration, Range, uri, Annotation, base64Binary, Signature, unsignedInt, time, Timing, decimal, CodeableConcept
[x] NoteSee Choice of Data Types for further information about how to use [x]
34. Patient.extension:nhsCommunication.extension:modeOfCommunication
SliceNamemodeOfCommunication
Definition

An Extension

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

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

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

35. Patient.extension:nhsCommunication.extension:modeOfCommunication.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Control1..1
Typeuri
XML RepresentationIn the XML format, this property is represented as an attribute.
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Fixed ValuemodeOfCommunication
36. Patient.extension:nhsCommunication.extension:modeOfCommunication.value[x]
Definition

Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

Control10..1
TypeChoice of: CodeableConcept, date, dateTime, Meta, code, string, Address, Attachment, integer, oid, Count, instant, ContactPoint, HumanName, Money, Identifier, Coding, markdown, SampledData, Ratio, id, positiveInt, Age, Distance, Reference, Period, Quantity, Duration, Range, uri, Annotation, boolean, base64Binary, Signature, unsignedInt, time, Timing, decimal
[x] NoteSee Choice of Data Types for further information about how to use [x]
SlicingThis element introduces a set of slices on Patient.extension.extension.value[x]. The slices are unordered and Closed, and can be differentiated using the following discriminators:
  • type @ $this
37. Patient.extension:nhsCommunication.extension:modeOfCommunication.value[x]:valueCodeableConcept
SliceNamevalueCodeableConcept
Definition

A valueset to describe the mode the patient can communicate in, representing the method of expression of the language..

Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

Control10..1
BindingThe codes SHALL be taken from Care Connect Language Ability ModeFor codes, see (unbound) Language Ability Mod
TypeChoice of: CodeableConcept, date, dateTime, Meta, code, string, Address, Attachment, integer, oid, Count, instant, ContactPoint, HumanName, Money, Identifier, Coding, markdown, SampledData, Ratio, id, positiveInt, Age, Distance, Reference, Period, Quantity, Duration, Range, uri, Annotation, boolean, base64Binary, Signature, unsignedInt, time, Timing, decimal
[x] NoteSee Choice of Data Types for further information about how to use [x]
38. Patient.extension:nhsCommunication.extension:communicationProficiency
SliceNamecommunicationProficiency
Definition

An Extension

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

Control0..1*
TypeExtension
Alternate Namesextensions, user content
Comments

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

39. Patient.extension:nhsCommunication.extension:communicationProficiency.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Control1..1
Typeuri
XML RepresentationIn the XML format, this property is represented as an attribute.
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Fixed ValuecommunicationProficiency
40. Patient.extension:nhsCommunication.extension:communicationProficiency.value[x]
Definition

Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

Control10..1
TypeChoice of: CodeableConcept, date, dateTime, Meta, code, string, Address, Attachment, integer, oid, Count, instant, ContactPoint, HumanName, Money, Identifier, Coding, markdown, SampledData, Ratio, id, positiveInt, Age, Distance, Reference, Period, Quantity, Duration, Range, uri, Annotation, boolean, base64Binary, Signature, unsignedInt, time, Timing, decimal
[x] NoteSee Choice of Data Types for further information about how to use [x]
SlicingThis element introduces a set of slices on Patient.extension.extension.value[x]. The slices are unordered and Closed, and can be differentiated using the following discriminators:
  • type @ $this
41. Patient.extension:nhsCommunication.extension:communicationProficiency.value[x]:valueCodeableConcept
SliceNamevalueCodeableConcept
Definition

A valueset to describe the level of proficiency in communicating a language.

Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

Control10..1
BindingThe codes SHALL be taken from Care Connect Language Ability ProficiencyFor codes, see (unbound) Language Ability Proficienc
TypeChoice of: CodeableConcept, date, dateTime, Meta, code, string, Address, Attachment, integer, oid, Count, instant, ContactPoint, HumanName, Money, Identifier, Coding, markdown, SampledData, Ratio, id, positiveInt, Age, Distance, Reference, Period, Quantity, Duration, Range, uri, Annotation, boolean, base64Binary, Signature, unsignedInt, time, Timing, decimal
[x] NoteSee Choice of Data Types for further information about how to use [x]
42. Patient.extension:nhsCommunication.extension:interpreterRequired
SliceNameinterpreterRequired
Definition

An Extension

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

Control0..1*
TypeExtension
Alternate Namesextensions, user content
Comments

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

43. Patient.extension:nhsCommunication.extension:interpreterRequired.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Control1..1
Typeuri
XML RepresentationIn the XML format, this property is represented as an attribute.
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Fixed ValueinterpreterRequired
44. Patient.extension:nhsCommunication.extension:interpreterRequired.value[x]
Definition

Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

Control10..1
TypeChoice of: boolean, date, dateTime, Meta, code, string, Address, Attachment, integer, oid, Count, instant, ContactPoint, HumanName, Money, Identifier, Coding, markdown, SampledData, Ratio, id, positiveInt, Age, Distance, Reference, Period, Quantity, Duration, Range, uri, Annotation, base64Binary, Signature, unsignedInt, time, Timing, decimal, CodeableConcept
[x] NoteSee Choice of Data Types for further information about how to use [x]
SlicingThis element introduces a set of slices on Patient.extension.extension.value[x]. The slices are unordered and Closed, and can be differentiated using the following discriminators:
  • type @ $this
45. Patient.extension:nhsCommunication.extension:interpreterRequired.value[x]:valueBoolean
SliceNamevalueBoolean
Definition

Indicates whether an interpreter is required for communication purposes- True / False?

Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

Control10..1
TypeChoice of: boolean, date, dateTime, Meta, code, string, Address, Attachment, integer, oid, Count, instant, ContactPoint, HumanName, Money, Identifier, Coding, markdown, SampledData, Ratio, id, positiveInt, Age, Distance, Reference, Period, Quantity, Duration, Range, uri, Annotation, base64Binary, Signature, unsignedInt, time, Timing, decimal, CodeableConcept
[x] NoteSee Choice of Data Types for further information about how to use [x]
46. Patient.extension:nhsCommunication.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Control1..1
Typeuri
XML RepresentationIn the XML format, this property is represented as an attribute.
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Fixed Valuehttps://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-NHSCommunication-1
47. Patient.extension:nhsCommunication.value[x]
Definition

Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

Control0..01
TypeChoice of: base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, Meta
[x] NoteSee Choice of Data Types for further information about how to use [x]
48. Patient.extension:birthPlace
SliceNamebirthPlace
Definition

Birth Place: The registered place of birth of the patient. A sytem may use the address.text if they don't store the birthPlace address in discrete elements.

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(ExtensionCareConnectbirthPlace) (Extension Type: Address)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
49. Patient.extension:nominatedPharmacy
SliceNamenominatedPharmacy
Definition

A patient's nominated pharmacy.

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(Extension-CareConnect-NominatedPharmacy-1) (Extension Type: Reference)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
50. Patient.extension:deathNotificationStatus
SliceNamedeathNotificationStatus
Definition

This extension is constrained to represent a patient’s death notification (as held on Personal Demographics Service (PDS)).

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

Control0..1* This element is affected by the following invariants: ele-1
TypeExtension(Extension-CareConnect-DeathNotificationStatus-1) (Complex Extension)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
51. Patient.extension:sexualOrientation
SliceNamesexualOrientation
Definition

Sexual Orientation, as per NHS Data Dictionary: Person Stated Sexual Orientation Code

Control0..1
TypeExtension(ExtensionInterweaveSexualOrientation) (Extension Type: CodeableConcept)
52. Patient.modifierExtension
Definition

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

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

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

53. Patient.identifier
Definition

An identifier for this patient.

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

Patients are almost always assigned specific numerical identifiers.

SlicingThis element introduces a set of slices on Patient.identifier. The slices are unordered and Open at End, and can be differentiated using the following discriminators:
  • value @ system
54. Patient.identifier:nhsNumber
SliceNamenhsNumber
Definition

An identifier for this patient.

NoteThis is a business identifier, not a resource identifier (see discussion)
Control10..1*
TypeIdentifier
Must Supporttrue
Summarytrue
Requirements

Patients are almost always assigned specific numerical identifiers.

55. Patient.identifier:nhsNumber.extension
Definition

An Extension

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

Control10..*
TypeExtension
Alternate Namesextensions, user content
Comments

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

SlicingThis element introduces a set of slices on Patient.identifier.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
56. Patient.identifier:nhsNumber.extension:nhsNumberVerificationStatus
SliceNamenhsNumberVerificationStatus
Definition

The verification/tracing status of the NHS number.

Control1..1
TypeExtension(Extension-CareConnect-NHSNumberVerificationStatus-1) (Extension Type: CodeableConcept)
57. Patient.identifier:nhsNumber.extension:nhsNumberVerificationStatus.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Control1..1
Typeuri
XML RepresentationIn the XML format, this property is represented as an attribute.
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Fixed Valuehttps://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-NHSNumberVerificationStatus-1
58. Patient.identifier:nhsNumber.extension:nhsNumberVerificationStatus.value[x]
Definition

Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

Control10..1
TypeChoice of: CodeableConcept, date, dateTime, Meta, code, string, Address, Attachment, integer, oid, Count, instant, ContactPoint, HumanName, Money, Identifier, Coding, markdown, SampledData, Ratio, id, positiveInt, Age, Distance, Reference, Period, Quantity, Duration, Range, uri, Annotation, boolean, base64Binary, Signature, unsignedInt, time, Timing, decimal
[x] NoteSee Choice of Data Types for further information about how to use [x]
SlicingThis element introduces a set of slices on Patient.identifier.extension.value[x]. The slices are unordered and Closed, and can be differentiated using the following discriminators:
  • type @ $this
59. Patient.identifier:nhsNumber.extension:nhsNumberVerificationStatus.value[x]:valueCodeableConcept
SliceNamevalueCodeableConcept
Definition

Verification status of the NHS number.

Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

Control10..1
BindingThe codes SHALL be taken from Care Connect NHS Number Verification StatusFor codes, see (unbound) NHS Number Verification Statu
TypeChoice of: CodeableConcept, date, dateTime, Meta, code, string, Address, Attachment, integer, oid, Count, instant, ContactPoint, HumanName, Money, Identifier, Coding, markdown, SampledData, Ratio, id, positiveInt, Age, Distance, Reference, Period, Quantity, Duration, Range, uri, Annotation, boolean, base64Binary, Signature, unsignedInt, time, Timing, decimal
[x] NoteSee Choice of Data Types for further information about how to use [x]
Fixed Value<valueCodeableConcept xmlns="http://hl7.org/fhir">
  <coding>
    <system value="https://fhir.hl7.org.uk/STU3/CodeSystem/CareConnect-NHSNumberVerificationStatus-1"/>
    <code value="01"/>
    <display value="Number present and verified"/>
  </coding>
</valueCodeableConcept>
60. Patient.identifier:nhsNumber.use
Definition

The purpose of this identifier.

Control0..1
BindingThe codes SHALL be taken from IdentifierUse

Identifies the purpose for this identifier, if known .

Typecode
Is Modifiertrue
Summarytrue
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.

61. Patient.identifier:nhsNumber.system
Definition

Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

Control10..1
Typeuri
Summarytrue
Requirements

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

Fixed Valuehttps://fhir.nhs.uk/Id/nhs-number
Example
General:http://www.acme.com/identifiers/patient
62. Patient.identifier:nhsNumber.value
Definition

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

Control10..1
Typestring
Summarytrue
Comments

If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension.

Example
General:123456
General:1234567890
63. Patient.active
Definition

Whether this patient record is in active use.

Control0..1
Typeboolean
Is Modifiertrue
Must Supporttrue
Summarytrue
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

This element is labeled as a modifier because when the patient record is marked as not active it is not expected to be used/referenced without being changed back to active.

Default Valuetrue
64. Patient.name
Definition

A name associated with the individual.

Control10..*
TypeHumanName
Summarytrue
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.

SlicingThis element introduces a set of slices on Patient.name. The slices are unordered and Open at End, and can be differentiated using the following discriminators:
  • value @ use
65. Patient.name:official
SliceNameofficial
Definition

A name associated with the individual.

Control10..1*
TypeHumanName
Must Supporttrue
Summarytrue
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.

66. Patient.name:official.use
Definition

Identifies the purpose for this name.

Control10..1
BindingThe codes SHALL be taken from NameUse

The use of a human name.

The use of a human name

Typecode
Is Modifiertrue
Must Supporttrue
Summarytrue
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.

Fixed Valueofficial
67. Patient.name:official.text
Definition

A full text representation of the name.

Control0..1
Typestring
Summarytrue
Requirements

A renderable, unencoded form.

Comments

Can provide both a text representation and structured parts.

68. Patient.name:official.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.

Control10..1
Typestring
Must Supporttrue
Summarytrue
Alternate Namessurname
Comments

Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures).

69. Patient.name:official.given
Definition

Given name.

Control10..*
Typestring
Must Supporttrue
Summarytrue
Alternate Namesfirst 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.

70. Patient.name:official.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
Must Supporttrue
Summarytrue
71. Patient.name:official.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
Must Supporttrue
Summarytrue
72. Patient.telecom
Definition

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

Control0..*
TypeContactPoint
Must Supporttrue
Summarytrue
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).

73. Patient.telecom.system
Definition

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

Control10..1 This element is affected by the following invariants: cpt-2
BindingThe codes SHALL be taken from ContactPointSystem

Telecommunications form for contact point

Typecode
Must Supporttrue
Summarytrue
74. 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).

Control10..1
Typestring
Must Supporttrue
Summarytrue
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.

75. Patient.telecom.use
Definition

Identifies the purpose for the contact point.

Control0..1
BindingThe codes SHALL be taken from ContactPointUse

Use of contact point

Typecode
Is Modifiertrue
Must Supporttrue
Summarytrue
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.

76. Patient.gender
Definition

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

Control0..1
BindingThe codes SHALL be taken from AdministrativeGender

The gender of a person used for administrative purposes.

Typecode
Must Supporttrue
Summarytrue
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. Note that for both humans and particularly animals, there are other legitimate possibilities than M and F, though the vast majority of systems and contexts only support M and F. Systems providing decision support or enforcing business rules should ideally do this on the basis of Observations dealing with the specific gender aspect of interest (anatomical, chromosonal, social, etc.) However, because these observations are infrequently recorded, defaulting to the administrative gender is common practice. Where such defaulting occurs, rule enforcement should allow for the variation between administrative and biological, chromosonal and other gender aspects. For example, an alert about a hysterectomy on a male should be handled as a warning or overrideable error, not a "hard" error.

77. Patient.birthDate
Definition

The date of birth for the individual.

Control10..1
Typedate
Must Supporttrue
Summarytrue
Requirements

Age of the individual drives many clinical processes.

Comments

At least an estimated year should be provided as a guess if the real DOB is unknown There is a standard extension "patient-birthTime" available that should be used where Time is required (such as in maternaty/infant care systems).

LOINC Code21112-8
78. Patient.birthDate.extension:patient-birthTime
SliceNamepatient-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.

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(birthTime) (Extension Type: dateTime)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
79. Patient.deceased[x]
Definition

Indicates if the individual is deceased or not.

Control0..1
TypeChoice of: boolean, dateTime
[x] NoteSee Choice of Data Types for further information about how to use [x]
Is Modifiertrue
Summarytrue
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.

This element is labeled as a modifier because once a patient is marked as deceased, the actions that are appropriate to perform on the patient may be significantly different.

80. Patient.address
Definition

Addresses for the individual.

Control0..*
TypeAddress
Must Supporttrue
Summarytrue
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.

81. Patient.address.use
Definition

The purpose of this address.

Control0..1
BindingThe codes SHALL be taken from AddressUse

The use of an address

Typecode
Is Modifiertrue
Must Supporttrue
Summarytrue
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
General:home
82. Patient.address.text
Definition

A full text representation of the address.

Control0..1
Typestring
Summarytrue
Requirements

A renderable, unencoded form.

Comments

Can provide both a text representation and parts.

Example
General:137 Nowhere Street, Erewhon 9132
General:42 Grove Street, Overtown, West Yorkshire, LS21 1PF
83. Patient.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.

Control0..*
Typestring
Must Supporttrue
Summarytrue
Requirements

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

Example
General:137 Nowhere Street
General:42 Grove Street
84. Patient.address.city
Definition

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

Control0..1
Typestring
Must Supporttrue
Summarytrue
Alternate NamesMunicpality
Example
General:Erewhon
General:Overtown
85. Patient.address.district
Definition

The name of the administrative area (county).

Control0..1
Typestring
Must Supporttrue
Summarytrue
Alternate NamesCounty
Comments

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

Example
General:Madison
General:West Yorkshire
86. Patient.address.postalCode
Definition

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

Control0..1
Typestring
Must Supporttrue
Summarytrue
Alternate NamesZip
Example
General:9132
General:LS21 1PF
87. Patient.photo
Definition

Image of the patient.

Control0..0*
TypeAttachment
Requirements

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

88. Patient.contact
Definition

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

Control0..*
TypeBackboneElement
Must Supporttrue
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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
pat-1: SHALL at least contain a contact's details or a reference to an organization (: name.exists() or telecom.exists() or address.exists() or organization.exists())
89. 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.

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

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

90. Patient.contact.relationship
Definition

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

Control0..*
BindingThe codes SHALL be taken from v2 Contact Role; other codes may be used where these codes are not suitable

The nature of the relationship between a patient and a contact person for that patient.

TypeCodeableConcept
Must Supporttrue
Requirements

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

91. Patient.contact.name
Definition

A name associated with the contact person.

Control10..1
TypeHumanName
Must Supporttrue
Requirements

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

92. Patient.contact.name.use
Definition

Identifies the purpose for this name.

Control10..1
BindingThe codes SHALL be taken from NameUse

The use of a human name

Typecode
Is Modifiertrue
Summarytrue
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.

93. Patient.contact.name.text
Definition

A full text representation of the name.

Control0..1
Typestring
Summarytrue
Requirements

A renderable, unencoded form.

Comments

Can provide both a text representation and structured parts.

94. Patient.contact.telecom
Definition

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

Control0..*
TypeContactPoint
Must Supporttrue
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.

95. Patient.animal
Definition

This patient is known to be an animal.

Control0..01
TypeBackboneElement
Is Modifiertrue
Summarytrue
Requirements

Many clinical systems are extended to care for animal patients as well as human.

Comments

The animal element is labeled "Is Modifier" since patients may be non-human. Systems SHALL either handle patient details appropriately (e.g. inform users patient is not human) or reject declared animal records. The absense of the animal element does not imply that the patient is a human. If a system requires such a positive assertion that the patient is human, an extension will be required. (Do not use a species of homo-sapiens in animal species, as this would incorrectly infer that the patient is an animal).

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
96. Patient.communication
Definition

Languages which may be used to communicate with the patient about his or her health.

Control0..0*
TypeBackboneElement
Requirements

If a patient does not speak the local language, interpreters may be required, so languages spoken and proficiency is an important things to keep track of both for patient and other persons of interest.

Comments

If no language is specified, this implies that the default local language is spoken. If you need to convey proficiency for multiple modes then you need multiple Patient.Communication associations. For animals, language is not a relevant field, and should be absent from the instance. If the Patient does not speak the default local language, then the Interpreter Required Standard can be used to explicitly declare that an interpreter is required.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
97. Patient.generalPractitioner
Definition

Patient's nominated care provider.

Control0..*
TypeReference(Organization|Practitioner)
Alternate NamescareProvider
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.

It is not to be used to record Care Teams, these should be in a CareTeam resource that may be linked to the CarePlan or EpisodeOfCare resources.

98. Patient.managingOrganization
Definition

Organization that is the custodian of the patient record.

Control0..1
TypeReference(CareConnect-Organization-1|Organization)
Summarytrue
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).

99. Patient.link
Definition

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

Control0..*
TypeBackboneElement
Is Modifiertrue
Summarytrue
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.

This element is labelled as a modifier because it may not be the main Patient resource, and the referenced patient should be used instead of this Patient record. This is when the link.type value is 'replaced-by'.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
100. 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.

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

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

101. Patient.link.other
Definition

The other patient resource that the link refers to.

Control1..1
TypeReference(Patient|RelatedPerson)
Summarytrue
Comments

Referencing a RelatedPerson here removes the need to use a Person record to associate a Patient and RelatedPerson as the same individual.

102. Patient.link.type
Definition

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

Control1..1
BindingThe codes SHALL be taken from LinkType

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

Typecode
Summarytrue

Guidance on how to interpret the contents of this table can be found here.

1. Patient
Definition

Demographics and other administrative information about an individual or animal receiving care or other health-related services.

Control0..*
Alternate NamesSubjectOfCare Client Resident
2. Patient.id
Definition

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

Control0..1
Typeid
Must Supporttrue
Summarytrue
Comments

The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

3. Patient.meta
Definition

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

Control0..1
TypeMeta
Summarytrue
4. Patient.meta.id
Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
5. Patient.meta.extension
Definition

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

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

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

SlicingThis element introduces a set of slices on Patient.meta.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
6. Patient.meta.versionId
Definition

The version specific identifier, as it appears in the version portion of the URL. This values changes when the resource is created, updated, or deleted.

Control0..1
Typeid
Must Supporttrue
Summarytrue
Comments

The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes.

7. Patient.meta.lastUpdated
Definition

When the resource last changed - e.g. when the version changed.

Control0..1
Typeinstant
Must Supporttrue
Summarytrue
Comments

This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant.

8. Patient.meta.profile
Definition

A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url.

Control0..*
Typeuri
Must Supporttrue
Summarytrue
Comments

It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set.

9. Patient.meta.security
Definition

Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.

Control0..*
BindingThe codes SHALL be taken from All Security Labels; other codes may be used where these codes are not suitable Security Labels from the Healthcare Privacy and Security Classification System
TypeCoding
Summarytrue
Comments

The security labels can be updated without changing the stated version of the resource The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored.

10. Patient.meta.tag
Definition

Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.

Control0..*
BindingFor example codes, see Common Tags Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones
TypeCoding
Summarytrue
Comments

The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored.

SlicingThis element introduces a set of slices on Patient.meta.tag. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ system
11. Patient.meta.tag:Source
SliceNameSource
Definition

Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.

Control0..1
BindingFor example codes, see Common Tags Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones
TypeCoding
Must Supporttrue
Summarytrue
Comments

The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored.

12. Patient.meta.tag:Source.id
Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
13. Patient.meta.tag:Source.extension
Definition

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

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

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

SlicingThis element introduces a set of slices on Patient.meta.tag.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
14. Patient.meta.tag:Source.system
Definition

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

Control1..1
Typeuri
Summarytrue
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 Valuehttps://yhcr.nhs.uk/Source
15. Patient.meta.tag:Source.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.

NoteThis is a business versionId, not a resource version id (see discussion)
Control0..1
Typestring
Summarytrue
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.

16. Patient.meta.tag:Source.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
Must Supporttrue
Summarytrue
Requirements

Need to refer to a particular code in the system.

17. Patient.meta.tag:Source.display
Definition

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

Control1..1
Typestring
Must Supporttrue
Summarytrue
Requirements

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

18. Patient.meta.tag:Source.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
Summarytrue
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.

19. Patient.meta.tag:Provenance
SliceNameProvenance
Definition

Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.

Control0..1
BindingFor example codes, see Common Tags Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones
TypeCoding
Must Supporttrue
Summarytrue
Comments

The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored.

20. Patient.meta.tag:Provenance.id
Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
21. Patient.meta.tag:Provenance.extension
Definition

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

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

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

SlicingThis element introduces a set of slices on Patient.meta.tag.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
22. Patient.meta.tag:Provenance.system
Definition

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

Control1..1
Typeuri
Summarytrue
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 Valuehttps://yhcr.nhs.uk/Provenance
23. Patient.meta.tag:Provenance.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.

NoteThis is a business versionId, not a resource version id (see discussion)
Control0..1
Typestring
Summarytrue
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.

24. Patient.meta.tag:Provenance.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
Must Supporttrue
Summarytrue
Requirements

Need to refer to a particular code in the system.

25. Patient.meta.tag:Provenance.display
Definition

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

Control1..1
Typestring
Must Supporttrue
Summarytrue
Requirements

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

26. Patient.meta.tag:Provenance.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
Summarytrue
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.

27. Patient.implicitRules
Definition

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

Control0..1
Typeuri
Is Modifiertrue
Summarytrue
Comments

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

This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.

28. Patient.language
Definition

The base language in which the resource is written.

Control0..1
BindingThe codes SHALL be taken from Common Languages; other codes may be used where these codes are not suitable A human language
Additional BindingsPurpose
AllLanguagesMax Binding
Typecode
Comments

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

29. Patient.text
Definition

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

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

Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded in formation is added later.

30. Patient.contained
Definition

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

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

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

31. Patient.extension
Definition

An Extension

Control0..*
TypeExtension
SlicingThis element introduces a set of slices on Patient.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
32. Patient.extension:ethnicCategory
SliceNameethnicCategory
Definition

The ethnicity of the subject.

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(Extension-CareConnect-EthnicCategory-1) (Extension Type: CodeableConcept)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
33. Patient.extension:religiousAffiliation
SliceNamereligiousAffiliation
Definition

The religious affiliation of the subject.

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(Extension-CareConnect-ReligiousAffiliation-1) (Extension Type: CodeableConcept)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
34. Patient.extension:patient-cadavericDonor
SliceNamepatient-cadavericDonor
Definition

Flag indicating whether the patient authorized the donation of body parts after death.

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(cadavericDonor) (Extension Type: boolean)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
35. Patient.extension:residentialStatus
SliceNameresidentialStatus
Definition

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

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(Extension-CareConnect-ResidentialStatus-1) (Extension Type: CodeableConcept)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
36. Patient.extension:treatmentCategory
SliceNametreatmentCategory
Definition

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

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(Extension-CareConnect-TreatmentCategory-1) (Extension Type: CodeableConcept)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
37. Patient.extension:nhsCommunication
SliceNamenhsCommunication
Definition

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

Control0..* This element is affected by the following invariants: ele-1
TypeExtension(Extension-CareConnect-NHSCommunication-1) (Complex Extension)
Must Supporttrue
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
38. Patient.extension:nhsCommunication.id
Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
39. Patient.extension:nhsCommunication.extension
Definition

An Extension

Control0..*
TypeExtension
SlicingThis element introduces a set of slices on Patient.extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
40. Patient.extension:nhsCommunication.extension:language
SliceNamelanguage
Definition

Languages which may be used for communication.

Control1..1
TypeExtension
41. Patient.extension:nhsCommunication.extension:language.id
Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
42. Patient.extension:nhsCommunication.extension:language.extension
Definition

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

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

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

SlicingThis element introduces a set of slices on Patient.extension.extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
43. Patient.extension:nhsCommunication.extension:language.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Control1..1
Typeuri
XML RepresentationIn the XML format, this property is represented as an attribute.
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Fixed Valuelanguage
44. Patient.extension:nhsCommunication.extension:language.value[x]
Definition

Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

Control1..1
TypeCodeableConcept
[x] NoteSee Choice of Data Types for further information about how to use [x]
SlicingThis element introduces a set of slices on Patient.extension.extension.value[x]. The slices are unordered and Closed, and can be differentiated using the following discriminators:
  • type @ $this
45. Patient.extension:nhsCommunication.extension:language.value[x]:valueCodeableConcept
SliceNamevalueCodeableConcept
Definition

Languages which may be used for communication.

Control1..1
BindingThe codes SHALL be taken from Care Connect Human Language Human Languag
TypeCodeableConcept
[x] NoteSee Choice of Data Types for further information about how to use [x]
46. Patient.extension:nhsCommunication.extension:preferred
SliceNamepreferred
Definition

An Extension

Control0..1
TypeExtension
47. Patient.extension:nhsCommunication.extension:preferred.id
Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
48. Patient.extension:nhsCommunication.extension:preferred.extension
Definition

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

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

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

SlicingThis element introduces a set of slices on Patient.extension.extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
49. Patient.extension:nhsCommunication.extension:preferred.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Control1..1
Typeuri
XML RepresentationIn the XML format, this property is represented as an attribute.
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Fixed Valuepreferred
50. Patient.extension:nhsCommunication.extension:preferred.value[x]
Definition

Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

Control1..1
Typeboolean
[x] NoteSee Choice of Data Types for further information about how to use [x]
SlicingThis element introduces a set of slices on Patient.extension.extension.value[x]. The slices are unordered and Closed, and can be differentiated using the following discriminators:
  • type @ $this
51. Patient.extension:nhsCommunication.extension:preferred.value[x]:valueBoolean
SliceNamevalueBoolean
Definition

Indicates whether or not this language is preferred (over other languages up a certain level)

Control1..1
Typeboolean
[x] NoteSee Choice of Data Types for further information about how to use [x]
52. Patient.extension:nhsCommunication.extension:modeOfCommunication
SliceNamemodeOfCommunication
Definition

An Extension

Control0..*
TypeExtension
53. Patient.extension:nhsCommunication.extension:modeOfCommunication.id
Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
54. Patient.extension:nhsCommunication.extension:modeOfCommunication.extension
Definition

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

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

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

SlicingThis element introduces a set of slices on Patient.extension.extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
55. Patient.extension:nhsCommunication.extension:modeOfCommunication.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Control1..1
Typeuri
XML RepresentationIn the XML format, this property is represented as an attribute.
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Fixed ValuemodeOfCommunication
56. Patient.extension:nhsCommunication.extension:modeOfCommunication.value[x]
Definition

Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

Control1..1
TypeCodeableConcept
[x] NoteSee Choice of Data Types for further information about how to use [x]
SlicingThis element introduces a set of slices on Patient.extension.extension.value[x]. The slices are unordered and Closed, and can be differentiated using the following discriminators:
  • type @ $this
57. Patient.extension:nhsCommunication.extension:modeOfCommunication.value[x]:valueCodeableConcept
SliceNamevalueCodeableConcept
Definition

A valueset to describe the mode the patient can communicate in, representing the method of expression of the language..

Control1..1
BindingThe codes SHALL be taken from Care Connect Language Ability Mode Language Ability Mod
TypeCodeableConcept
[x] NoteSee Choice of Data Types for further information about how to use [x]
58. Patient.extension:nhsCommunication.extension:communicationProficiency
SliceNamecommunicationProficiency
Definition

An Extension

Control0..1
TypeExtension
59. Patient.extension:nhsCommunication.extension:communicationProficiency.id
Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
60. Patient.extension:nhsCommunication.extension:communicationProficiency.extension
Definition

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

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

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

SlicingThis element introduces a set of slices on Patient.extension.extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
61. Patient.extension:nhsCommunication.extension:communicationProficiency.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Control1..1
Typeuri
XML RepresentationIn the XML format, this property is represented as an attribute.
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Fixed ValuecommunicationProficiency
62. Patient.extension:nhsCommunication.extension:communicationProficiency.value[x]
Definition

Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

Control1..1
TypeCodeableConcept
[x] NoteSee Choice of Data Types for further information about how to use [x]
SlicingThis element introduces a set of slices on Patient.extension.extension.value[x]. The slices are unordered and Closed, and can be differentiated using the following discriminators:
  • type @ $this
63. Patient.extension:nhsCommunication.extension:communicationProficiency.value[x]:valueCodeableConcept
SliceNamevalueCodeableConcept
Definition

A valueset to describe the level of proficiency in communicating a language.

Control1..1
BindingThe codes SHALL be taken from Care Connect Language Ability Proficiency Language Ability Proficienc
TypeCodeableConcept
[x] NoteSee Choice of Data Types for further information about how to use [x]
64. Patient.extension:nhsCommunication.extension:interpreterRequired
SliceNameinterpreterRequired
Definition

An Extension

Control0..1
TypeExtension
65. Patient.extension:nhsCommunication.extension:interpreterRequired.id
Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
66. Patient.extension:nhsCommunication.extension:interpreterRequired.extension
Definition

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

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

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

SlicingThis element introduces a set of slices on Patient.extension.extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
67. Patient.extension:nhsCommunication.extension:interpreterRequired.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Control1..1
Typeuri
XML RepresentationIn the XML format, this property is represented as an attribute.
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Fixed ValueinterpreterRequired
68. Patient.extension:nhsCommunication.extension:interpreterRequired.value[x]
Definition

Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

Control1..1
Typeboolean
[x] NoteSee Choice of Data Types for further information about how to use [x]
SlicingThis element introduces a set of slices on Patient.extension.extension.value[x]. The slices are unordered and Closed, and can be differentiated using the following discriminators:
  • type @ $this
69. Patient.extension:nhsCommunication.extension:interpreterRequired.value[x]:valueBoolean
SliceNamevalueBoolean
Definition

Indicates whether an interpreter is required for communication purposes- True / False?

Control1..1
Typeboolean
[x] NoteSee Choice of Data Types for further information about how to use [x]
70. Patient.extension:nhsCommunication.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Control1..1
Typeuri
XML RepresentationIn the XML format, this property is represented as an attribute.
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Fixed Valuehttps://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-NHSCommunication-1
71. Patient.extension:nhsCommunication.value[x]
Definition

Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

Control0..0
TypeChoice of: base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, Meta
[x] NoteSee Choice of Data Types for further information about how to use [x]
72. Patient.extension:birthPlace
SliceNamebirthPlace
Definition

Birth Place: The registered place of birth of the patient. A sytem may use the address.text if they don't store the birthPlace address in discrete elements.

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(ExtensionCareConnectbirthPlace) (Extension Type: Address)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
73. Patient.extension:nominatedPharmacy
SliceNamenominatedPharmacy
Definition

A patient's nominated pharmacy.

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(Extension-CareConnect-NominatedPharmacy-1) (Extension Type: Reference)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
74. Patient.extension:deathNotificationStatus
SliceNamedeathNotificationStatus
Definition

This extension is constrained to represent a patient’s death notification (as held on Personal Demographics Service (PDS)).

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(Extension-CareConnect-DeathNotificationStatus-1) (Complex Extension)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
75. Patient.extension:sexualOrientation
SliceNamesexualOrientation
Definition

Sexual Orientation, as per NHS Data Dictionary: Person Stated Sexual Orientation Code

Control0..1
TypeExtension(ExtensionInterweaveSexualOrientation) (Extension Type: CodeableConcept)
76. Patient.modifierExtension
Definition

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

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

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

77. Patient.identifier
Definition

An identifier for this patient.

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

Patients are almost always assigned specific numerical identifiers.

SlicingThis element introduces a set of slices on Patient.identifier. The slices are unordered and Open at End, and can be differentiated using the following discriminators:
  • value @ system
78. Patient.identifier:nhsNumber
SliceNamenhsNumber
Definition

An identifier for this patient.

NoteThis is a business identifier, not a resource identifier (see discussion)
Control1..1
TypeIdentifier
Must Supporttrue
Summarytrue
Requirements

Patients are almost always assigned specific numerical identifiers.

79. Patient.identifier:nhsNumber.id
Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
80. Patient.identifier:nhsNumber.extension
Definition

An Extension

Control1..*
TypeExtension
SlicingThis element introduces a set of slices on Patient.identifier.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
81. Patient.identifier:nhsNumber.extension:nhsNumberVerificationStatus
SliceNamenhsNumberVerificationStatus
Definition

The verification/tracing status of the NHS number.

Control1..1
TypeExtension(Extension-CareConnect-NHSNumberVerificationStatus-1) (Extension Type: CodeableConcept)
82. Patient.identifier:nhsNumber.extension:nhsNumberVerificationStatus.id
Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
83. Patient.identifier:nhsNumber.extension:nhsNumberVerificationStatus.extension
Definition

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

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

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

SlicingThis element introduces a set of slices on Patient.identifier.extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
84. Patient.identifier:nhsNumber.extension:nhsNumberVerificationStatus.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Control1..1
Typeuri
XML RepresentationIn the XML format, this property is represented as an attribute.
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Fixed Valuehttps://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-NHSNumberVerificationStatus-1
85. Patient.identifier:nhsNumber.extension:nhsNumberVerificationStatus.value[x]
Definition

Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

Control1..1
TypeCodeableConcept
[x] NoteSee Choice of Data Types for further information about how to use [x]
SlicingThis element introduces a set of slices on Patient.identifier.extension.value[x]. The slices are unordered and Closed, and can be differentiated using the following discriminators:
  • type @ $this
86. Patient.identifier:nhsNumber.extension:nhsNumberVerificationStatus.value[x]:valueCodeableConcept
SliceNamevalueCodeableConcept
Definition

Verification status of the NHS number.

Control1..1
BindingThe codes SHALL be taken from Care Connect NHS Number Verification Status NHS Number Verification Statu
TypeCodeableConcept
[x] NoteSee Choice of Data Types for further information about how to use [x]
Fixed Value<valueCodeableConcept xmlns="http://hl7.org/fhir">
  <coding>
    <system value="https://fhir.hl7.org.uk/STU3/CodeSystem/CareConnect-NHSNumberVerificationStatus-1"/>
    <code value="01"/>
    <display value="Number present and verified"/>
  </coding>
</valueCodeableConcept>
87. Patient.identifier:nhsNumber.use
Definition

The purpose of this identifier.

Control0..1
BindingThe codes SHALL be taken from IdentifierUse Identifies the purpose for this identifier, if known
Typecode
Is Modifiertrue
Summarytrue
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.

88. Patient.identifier:nhsNumber.type
Definition

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

Control0..1
BindingThe codes SHALL be taken from Identifier Type Codes; other codes may be used where these codes are not suitable A coded type for an identifier that can be used to determine which identifier to use for a specific purpose
TypeCodeableConcept
Summarytrue
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.

89. Patient.identifier:nhsNumber.system
Definition

Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

Control1..1
Typeuri
Summarytrue
Requirements

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

Fixed Valuehttps://fhir.nhs.uk/Id/nhs-number
Example
General:http://www.acme.com/identifiers/patient
90. Patient.identifier:nhsNumber.value
Definition

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

Control1..1
Typestring
Summarytrue
Comments

If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension.

Example
General:123456
General:1234567890
91. Patient.identifier:nhsNumber.period
Definition

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

Control0..1
TypePeriod
Summarytrue
92. Patient.identifier:nhsNumber.assigner
Definition

Organization that issued/manages the identifier.

Control0..1
TypeReference(CareConnect-Organization-1)
Summarytrue
Comments

The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

93. Patient.active
Definition

Whether this patient record is in active use.

Control0..1
Typeboolean
Is Modifiertrue
Must Supporttrue
Summarytrue
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

This element is labeled as a modifier because when the patient record is marked as not active it is not expected to be used/referenced without being changed back to active.

Default Valuetrue
94. Patient.name
Definition

A name associated with the individual.

Control1..*
TypeHumanName
Summarytrue
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.

SlicingThis element introduces a set of slices on Patient.name. The slices are unordered and Open at End, and can be differentiated using the following discriminators:
  • value @ use
95. Patient.name:official
SliceNameofficial
Definition

A name associated with the individual.

Control1..1
TypeHumanName
Must Supporttrue
Summarytrue
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.

96. Patient.name:official.id
Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
97. Patient.name:official.extension
Definition

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

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

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

SlicingThis element introduces a set of slices on Patient.name.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
98. Patient.name:official.use
Definition

Identifies the purpose for this name.

Control1..1
BindingThe codes SHALL be taken from NameUse The use of a human name
Typecode
Is Modifiertrue
Must Supporttrue
Summarytrue
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.

Fixed Valueofficial
99. Patient.name:official.text
Definition

A full text representation of the name.

Control0..1
Typestring
Summarytrue
Requirements

A renderable, unencoded form.

Comments

Can provide both a text representation and structured parts.

100. Patient.name:official.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.

Control1..1
Typestring
Must Supporttrue
Summarytrue
Alternate Namessurname
Comments

Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures).

101. Patient.name:official.given
Definition

Given name.

Control1..*
Typestring
Must Supporttrue
Summarytrue
Alternate Namesfirst 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.

102. Patient.name:official.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
Must Supporttrue
Summarytrue
103. Patient.name:official.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
Must Supporttrue
Summarytrue
104. Patient.name:official.period
Definition

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

Control0..1
TypePeriod
Summarytrue
Requirements

Allows names to be placed in historical context.

105. Patient.telecom
Definition

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

Control0..*
TypeContactPoint
Must Supporttrue
Summarytrue
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).

106. Patient.telecom.id
Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
107. Patient.telecom.extension
Definition

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

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

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

SlicingThis element introduces a set of slices on Patient.telecom.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
108. Patient.telecom.system
Definition

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

Control1..1 This element is affected by the following invariants: cpt-2
BindingThe codes SHALL be taken from ContactPointSystem Telecommunications form for contact poin
Typecode
Must Supporttrue
Summarytrue
109. 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).

Control1..1
Typestring
Must Supporttrue
Summarytrue
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.

110. Patient.telecom.use
Definition

Identifies the purpose for the contact point.

Control0..1
BindingThe codes SHALL be taken from ContactPointUse Use of contact poin
Typecode
Is Modifiertrue
Must Supporttrue
Summarytrue
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.

111. Patient.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
Summarytrue
Comments

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

112. Patient.telecom.period
Definition

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

Control0..1
TypePeriod
Summarytrue
113. Patient.gender
Definition

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

Control0..1
BindingThe codes SHALL be taken from AdministrativeGender The gender of a person used for administrative purposes
Typecode
Must Supporttrue
Summarytrue
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. Note that for both humans and particularly animals, there are other legitimate possibilities than M and F, though the vast majority of systems and contexts only support M and F. Systems providing decision support or enforcing business rules should ideally do this on the basis of Observations dealing with the specific gender aspect of interest (anatomical, chromosonal, social, etc.) However, because these observations are infrequently recorded, defaulting to the administrative gender is common practice. Where such defaulting occurs, rule enforcement should allow for the variation between administrative and biological, chromosonal and other gender aspects. For example, an alert about a hysterectomy on a male should be handled as a warning or overrideable error, not a "hard" error.

114. Patient.birthDate
Definition

The date of birth for the individual.

Control1..1
Typedate
Must Supporttrue
Summarytrue
Requirements

Age of the individual drives many clinical processes.

Comments

At least an estimated year should be provided as a guess if the real DOB is unknown There is a standard extension "patient-birthTime" available that should be used where Time is required (such as in maternaty/infant care systems).

LOINC Code21112-8
115. Patient.birthDate.id
Definition

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

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
116. Patient.birthDate.extension
Definition

An Extension

Control0..*
TypeExtension
SlicingThis element introduces a set of slices on Patient.birthDate.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
117. Patient.birthDate.extension:patient-birthTime
SliceNamepatient-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.

Control0..1 This element is affected by the following invariants: ele-1
TypeExtension(birthTime) (Extension Type: dateTime)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
118. Patient.birthDate.value
Definition

The actual value

Control0..1
Typedate
XML RepresentationIn the XML format, this property is represented as an attribute.
119. Patient.deceased[x]
Definition

Indicates if the individual is deceased or not.

Control0..1
TypeChoice of: boolean, dateTime
[x] NoteSee Choice of Data Types for further information about how to use [x]
Is Modifiertrue
Summarytrue
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.

This element is labeled as a modifier because once a patient is marked as deceased, the actions that are appropriate to perform on the patient may be significantly different.

120. Patient.address
Definition

Addresses for the individual.

Control0..*
TypeAddress
Must Supporttrue
Summarytrue
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.

121. Patient.address.id
Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
122. Patient.address.extension
Definition

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

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

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

SlicingThis element introduces a set of slices on Patient.address.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
123. Patient.address.use
Definition

The purpose of this address.

Control0..1
BindingThe codes SHALL be taken from AddressUse The use of an addres
Typecode
Is Modifiertrue
Must Supporttrue
Summarytrue
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
General:home
124. 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.

Control0..1
BindingThe codes SHALL be taken from AddressType The type of an address (physical / postal
Typecode
Summarytrue
Example
General:both
125. Patient.address.text
Definition

A full text representation of the address.

Control0..1
Typestring
Summarytrue
Requirements

A renderable, unencoded form.

Comments

Can provide both a text representation and parts.

Example
General:137 Nowhere Street, Erewhon 9132
General:42 Grove Street, Overtown, West Yorkshire, LS21 1PF
126. Patient.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.

Control0..*
Typestring
Must Supporttrue
Summarytrue
Requirements

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

Example
General:137 Nowhere Street
General:42 Grove Street
127. Patient.address.city
Definition

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

Control0..1
Typestring
Must Supporttrue
Summarytrue
Alternate NamesMunicpality
Example
General:Erewhon
General:Overtown
128. Patient.address.district
Definition

The name of the administrative area (county).

Control0..1
Typestring
Must Supporttrue
Summarytrue
Alternate NamesCounty
Comments

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

Example
General:Madison
General:West Yorkshire
129. Patient.address.state
Definition

Sub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (i.e. US 2 letter state codes).

Control0..1
Typestring
Summarytrue
Alternate NamesProvince, Territory
130. Patient.address.postalCode
Definition

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

Control0..1
Typestring
Must Supporttrue
Summarytrue
Alternate NamesZip
Example
General:9132
General:LS21 1PF
131. Patient.address.country
Definition

Country - a nation as commonly understood or generally accepted.

Control0..1
Typestring
Summarytrue
Comments

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

Example
General:GBR
132. Patient.address.period
Definition

Time period when address was/is in use.

Control0..1
TypePeriod
Summarytrue
Requirements

Allows addresses to be placed in historical context.

Example
General:<valuePeriod xmlns="http://hl7.org/fhir">
  <start value="2010-03-23"/>
  <end value="2010-07-01"/>
</valuePeriod>
133. Patient.maritalStatus
Definition

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

Control0..1
BindingThe codes SHALL be taken from Marital Status Codes The domestic partnership status of a person
TypeCodeableConcept
Requirements

Most, if not all systems capture it.

134. Patient.maritalStatus.id
Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
135. Patient.maritalStatus.extension
Definition

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

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

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

SlicingThis element introduces a set of slices on Patient.maritalStatus.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
136. Patient.maritalStatus.coding
Definition

A reference to a code defined by a terminology system.

Control1..1
TypeCoding
Summarytrue
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 labeled as UserSelected = true.

137. Patient.maritalStatus.coding.id
Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
138. Patient.maritalStatus.coding.extension
Definition

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

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

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

SlicingThis element introduces a set of slices on Patient.maritalStatus.coding.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
139. Patient.maritalStatus.coding.system
Definition

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

Control1..1
Typeuri
Summarytrue
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
General:http://hl7.org/fhir/v3/MaritalStatus
140. 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.

NoteThis is a business versionId, not a resource version id (see discussion)
Control0..1
Typestring
Summarytrue
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.

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

Control1..1
Typecode
Summarytrue
Requirements

Need to refer to a particular code in the system.

142. Patient.maritalStatus.coding.display
Definition

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

Control1..1
Typestring
Summarytrue
Requirements

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

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

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

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

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

145. Patient.multipleBirth[x]
Definition

Indicates whether the patient is part of a multiple (bool) or indicates the actual birth order (integer).

Control0..1
TypeChoice of: boolean, integer
[x] NoteSee Choice of Data Types for further information about how to use [x]
Requirements

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

Comments

Where the valueInteger is provided, the number is the birth number in the sequence. E.g. The middle birth in tripplets would be valueInteger=2 and the third born would have valueInteger=3 If a bool value was provided for this tripplets examle, then all 3 patient records would have valueBool=true (the ordering is not indicated).

146. Patient.photo
Definition

Image of the patient.

Control0..0
TypeAttachment
Requirements

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

147. Patient.contact
Definition

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

Control0..*
TypeBackboneElement
Must Supporttrue
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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
pat-1: SHALL at least contain a contact's details or a reference to an organization (: name.exists() or telecom.exists() or address.exists() or organization.exists())
148. Patient.contact.id
Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
149. Patient.contact.extension
Definition

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

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

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

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

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

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

151. Patient.contact.relationship
Definition

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

Control0..*
BindingThe codes SHALL be taken from v2 Contact Role; other codes may be used where these codes are not suitable The nature of the relationship between a patient and a contact person for that patient
TypeCodeableConcept
Must Supporttrue
Requirements

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

152. Patient.contact.relationship.id
Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
153. Patient.contact.relationship.extension
Definition

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

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

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

SlicingThis element introduces a set of slices on Patient.contact.relationship.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
154. Patient.contact.relationship.coding
Definition

A reference to a code defined by a terminology system.

Control0..*
TypeCoding
Summarytrue
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 labeled as UserSelected = true.

155. Patient.contact.relationship.coding.id
Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
156. Patient.contact.relationship.coding.extension
Definition

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

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

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

SlicingThis element introduces a set of slices on Patient.contact.relationship.coding.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
157. Patient.contact.relationship.coding.system
Definition

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

Control1..1
Typeuri
Summarytrue
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.

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

NoteThis is a business versionId, not a resource version id (see discussion)
Control0..1
Typestring
Summarytrue
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.

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

Control1..1
Typecode
Summarytrue
Requirements

Need to refer to a particular code in the system.

160. Patient.contact.relationship.coding.display
Definition

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

Control1..1
Typestring
Summarytrue
Requirements

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

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

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

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

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

163. Patient.contact.name
Definition

A name associated with the contact person.

Control1..1
TypeHumanName
Must Supporttrue
Requirements

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

164. Patient.contact.name.id
Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
165. Patient.contact.name.extension
Definition

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

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

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

SlicingThis element introduces a set of slices on Patient.contact.name.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
166. Patient.contact.name.use
Definition

Identifies the purpose for this name.

Control1..1
BindingThe codes SHALL be taken from NameUse The use of a human nam
Typecode
Is Modifiertrue
Summarytrue
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.

167. Patient.contact.name.text
Definition

A full text representation of the name.

Control0..1
Typestring
Summarytrue
Requirements

A renderable, unencoded form.

Comments

Can provide both a text representation and structured parts.

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

Control0..1
Typestring
Summarytrue
Alternate Namessurname
Comments

Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures).

169. Patient.contact.name.given
Definition

Given name.

Control0..*
Typestring
Summarytrue
Alternate Namesfirst 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.

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

Control0..*
Typestring
Summarytrue
171. 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.

Control0..*
Typestring
Summarytrue
172. Patient.contact.name.period
Definition

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

Control0..1
TypePeriod
Summarytrue
Requirements

Allows names to be placed in historical context.

173. Patient.contact.telecom
Definition

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

Control0..*
TypeContactPoint
Must Supporttrue
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.

174. Patient.contact.address
Definition

Address for the contact person.

Control0..1
TypeAddress
Requirements

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

175. Patient.contact.address.id
Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
176. Patient.contact.address.extension
Definition

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

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

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

SlicingThis element introduces a set of slices on Patient.contact.address.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
177. Patient.contact.address.use
Definition

The purpose of this address.

Control0..1
BindingThe codes SHALL be taken from AddressUse The use of an addres
Typecode
Is Modifiertrue
Summarytrue
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
General:home
178. 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.

Control0..1
BindingThe codes SHALL be taken from AddressType The type of an address (physical / postal
Typecode
Summarytrue
Example
General:both
179. Patient.contact.address.text
Definition

A full text representation of the address.

Control0..1
Typestring
Summarytrue
Requirements

A renderable, unencoded form.

Comments

Can provide both a text representation and parts.

Example
General:137 Nowhere Street, Erewhon 9132
General:120, Grove Street, Overtown, West Yorkshire, LS21 1PT
180. Patient.contact.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.

Control0..*
Typestring
Summarytrue
Requirements

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

Example
General:137 Nowhere Street
General:120, Grove Street
181. Patient.contact.address.city
Definition

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

Control0..1
Typestring
Summarytrue
Alternate NamesMunicpality
Example
General:Erewhon
General:Overtown
182. Patient.contact.address.district
Definition

The name of the administrative area (county).

Control0..1
Typestring
Summarytrue
Alternate NamesCounty
Comments

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

Example
General:Madison
General:West Yorkshire
183. Patient.contact.address.state
Definition

Sub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (i.e. US 2 letter state codes).

Control0..1
Typestring
Summarytrue
Alternate NamesProvince, Territory
184. Patient.contact.address.postalCode
Definition

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

Control0..1
Typestring
Summarytrue
Alternate NamesZip
Example
General:9132
General:LS21 1PT
185. Patient.contact.address.country
Definition

Country - a nation as commonly understood or generally accepted.

Control0..1
Typestring
Summarytrue
Comments

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

Example
General:GBR
186. Patient.contact.address.period
Definition

Time period when address was/is in use.

Control0..1
TypePeriod
Summarytrue
Requirements

Allows addresses to be placed in historical context.

Example
General:<valuePeriod xmlns="http://hl7.org/fhir">
  <start value="2010-03-23"/>
  <end value="2010-07-01"/>
</valuePeriod>
187. Patient.contact.gender
Definition

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

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

Needed to address the person correctly.

188. Patient.contact.organization
Definition

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

Control0..1 This element is affected by the following invariants: pat-1
TypeReference(CareConnect-Organization-1)
Requirements

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

189. Patient.contact.period
Definition

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

Control0..1
TypePeriod
190. Patient.animal
Definition

This patient is known to be an animal.

Control0..0
TypeBackboneElement
Is Modifiertrue
Summarytrue
Requirements

Many clinical systems are extended to care for animal patients as well as human.

Comments

The animal element is labeled "Is Modifier" since patients may be non-human. Systems SHALL either handle patient details appropriately (e.g. inform users patient is not human) or reject declared animal records. The absense of the animal element does not imply that the patient is a human. If a system requires such a positive assertion that the patient is human, an extension will be required. (Do not use a species of homo-sapiens in animal species, as this would incorrectly infer that the patient is an animal).

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
191. Patient.communication
Definition

Languages which may be used to communicate with the patient about his or her health.

Control0..0
TypeBackboneElement
Requirements

If a patient does not speak the local language, interpreters may be required, so languages spoken and proficiency is an important things to keep track of both for patient and other persons of interest.

Comments

If no language is specified, this implies that the default local language is spoken. If you need to convey proficiency for multiple modes then you need multiple Patient.Communication associations. For animals, language is not a relevant field, and should be absent from the instance. If the Patient does not speak the default local language, then the Interpreter Required Standard can be used to explicitly declare that an interpreter is required.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
192. Patient.generalPractitioner
Definition

Patient's nominated care provider.

Control0..*
TypeReference(Organization|Practitioner)
Alternate NamescareProvider
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.

It is not to be used to record Care Teams, these should be in a CareTeam resource that may be linked to the CarePlan or EpisodeOfCare resources.

193. Patient.managingOrganization
Definition

Organization that is the custodian of the patient record.

Control0..1
TypeReference(CareConnect-Organization-1)
Summarytrue
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).

194. Patient.link
Definition

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

Control0..*
TypeBackboneElement
Is Modifiertrue
Summarytrue
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.

This element is labelled as a modifier because it may not be the main Patient resource, and the referenced patient should be used instead of this Patient record. This is when the link.type value is 'replaced-by'.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
195. Patient.link.id
Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
196. Patient.link.extension
Definition

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

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

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

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

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

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

198. Patient.link.other
Definition

The other patient resource that the link refers to.

Control1..1
TypeReference(Patient|RelatedPerson)
Summarytrue
Comments

Referencing a RelatedPerson here removes the need to use a Person record to associate a Patient and RelatedPerson as the same individual.

199. Patient.link.type
Definition

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

Control1..1
BindingThe codes SHALL be taken from LinkType The type of link between this patient resource and another patient resource
Typecode
Summarytrue