CDA On FHIR England - End of Life Care Document

COFE-Patient-1

This Patient resource constrains the patient information supported by CDA to make it suitable for NHS use.

NameCard.TypeDescription & Constraints
..PatientPatientThis Patient resource constrains the patient information supported by CDA to make it suitable for NHS use.

...Religious Affiliation0..1ExtensionReligious affiliation of the patient
Extension http://fhir.nhs.net/StructureDefinition/extension-cofe-religious-affiliation-1

...Ethnic Category0..1ExtensionEthnic group which the patient belongs too.
Extension http://fhir.nhs.net/StructureDefinition/extension-cofe-ethnic-category-1

...Birth Place0..1ExtensionDetails of the actual place which is the place of birth
Extension http://hl7.org/fhir/StructureDefinition/birthPlace

...Patient Birth Time0..1ExtensionThe time of day that the Patient was born. This includes the date to ensure that the timezone information can be communicated effectively.
Extension http://hl7.org/fhir/StructureDefinition/patient-birthTime

...identifierAn identifier for this patient
Slice: Ordering: Unordered, Discriminator: system, Rules: Closed

...identifier (NHS Number)0..1IdentifierIdentification of the patient using the NHS number

....NHS Number Verification Status0..1ExtensionVerification status of the NHS number
Extension http://fhir.nhs.net/StructureDefinition/extension-cofe-nhs-number-verification-status-1

....system1..1UriThe namespace for the identifier
Fixed Value http://fhir.nhs.net/Id/nhs-number

....value1..1StringThe value that is unique
Example Value 410 123 4422

...identifier (Local Patient Identifier)0..1IdentifierAn identifier for this patient

....use0..1Codeusual | official | temp | secondary (If known)
Binding Identifies the purpose for this identifier, if known . (http://hl7.org/fhir/ValueSet/identifier-use)
Binding Strength Required

....system1..1UriThe element shall contain the Local Person Identifier
Fixed Value http://fhir.nhs.net/Id/local-person-identifier

....value1..1StringShall contain the local patient identifier
Example Value L112233

....period0..1PeriodTime period when id is/was valid for use

.....start0..1DateTimeStarting time with inclusive boundary

.....end0..1DateTimeEnd time with inclusive boundary, if not ongoing

....assigner (assigningAuthorityName)0..1Reference (cofe-organization-ods-1)Organization that issued id (may be just text)

.....reference0..1StringRelative URL reference

.....display0..1StringShall contain the assigning organisation in the format of ODSCode:ODSName
Example Value RA9:SOUTH DEVON HEALTHCARE NHS TRUST

...name1..*HumanNameA name associated with the patient

....use0..1Codeusual | official | temp | nickname | anonymous | old | maiden
Binding The use of a human name (http://hl7.org/fhir/ValueSet/name-use)
Binding Strength Required

....text0..1StringText representation of the full name

....family0..1StringFamily name (often called 'Surname')
Example Value Wright

....given0..*StringGiven names (not always 'first'). Includes middle names
Example Value Ray

....prefix0..1StringParts that come before the name
Example Value Mr

....suffix0..*StringParts that come after the name

....period0..1PeriodTime period when name was/is in use

.....start0..1DateTimeStarting time with inclusive boundary

.....end0..1DateTimeEnd time with inclusive boundary, if not ongoing

...telecom0..*ContactPointA contact number for the individual

....system1..1Codephone | fax | email | pager | other
Binding Telecommunications form for contact point (http://hl7.org/fhir/ValueSet/contact-point-system)
Binding Strength Required
Fixed Value phone

....value1..1StringThe actual contact point details in ITU-T E.123 format.
Example Value +44 191 4028507

....use0..1Codehome | work | temp | old | mobile - purpose of this contact point
Binding Use of contact point (http://hl7.org/fhir/ValueSet/contact-point-use)
Binding Strength Required
Example Value home

....period0..1PeriodTime period when the contact point was/is in use

.....start0..1DateTimeStarting time with inclusive boundary

.....end0..1DateTimeEnd time with inclusive boundary, if not ongoing

...gender1..1Codemale | female | not specified | not known
Binding The gender of a person used for administrative purposes. (http://fhir.nhs.net/ValueSet/administrative-gender-1)
Binding Strength Required
Example Value male

...birthDate0..1DateThe date and time of birth for the individual
Example Value 2007-06-06T00:00:00+01:00

...deceased[x]0..1Boolean | DateTimeIndicates if the individual is deceased or not

...address0..4AddressAddresses for the patient.

....use0..1Codehome | work | temp | old - purpose of this address
Binding The use of an address (http://hl7.org/fhir/ValueSet/address-use)
Binding Strength Required
Example Value home

....type0..1Codepostal | physical | both
Binding The type of an address (physical / postal) (http://hl7.org/fhir/ValueSet/address-type)
Binding Strength Required
Example Value both

....line0..*StringStreet number and name.
Example Value 8 Witney Way

....city0..1StringName of city or town of residence
Example Value Boldon

....district0..1StringName of county of residence
Example Value Madison

....postalCode0..1StringPostal code for area
Example Value NE35 9PE

....country0..1StringCountry (ISO 3166-1 3 letter code)
Example Value GBR

....period0..1PeriodTime period when address was/is in use
Example Value Hl7.Fhir.Model.Period

.....start1..1DateTimeStarting time with inclusive boundary

.....end0..1DateTimeEnd time with inclusive boundary, if not ongoing

...maritalStatus0..1CodeableConceptMarital (civil) status of a patient
Binding The domestic partnership status of a person. (http://hl7.org/fhir/ValueSet/marital-status)
Binding Strength Required

....coding1..1CodingCode defined by a terminology system

.....system1..1UriIdentity of the terminology system
Example Value http://fhir.nhs.net/ValueSet/marital-status-1-0

.....code1..1CodeSymbol in syntax defined by the system
Binding Marital status of patient (http://fhir.nhs.net/ValueSet/marital-status-1)
Binding Strength Example
Example Value M

.....display1..1StringRepresentation defined by the system
Example Value Married

...multipleBirth[x]0..1Boolean | IntegerWhether patient is part of a multiple birth (2 or more)

...contact (Guardian)0..1BackboneElementA contact party (e.g. guardian, partner, friend) for the patient

....Guardian Identifier0..*ExtensionEnables the identification of the guardian using the NHS number, or a local identifier if the NHS number is not available. Where the guardian is an organisation this attribute is not used.
Extension http://fhir.nhs.net/StructureDefinition/extension-cofe-guardian-identifier-1

....relationship (Guardian Role Type)0..1CodeableConceptThe guardian for the patient.
Binding The nature of the relationship between a patient and a contact person for that patient. (http://fhir.nhs.net/ValueSet/guardian-role-type-1)
Binding Strength Required

.....coding0..1CodingCode defined by a terminology system

......system1..1UriIdentity of the terminology system
Fixed Value http://fhir.nhs.net/ValueSet/guardian-role-type-1

......code1..1CodeSymbol in syntax defined by the system
Binding A vocabulary that may be used to give further information about the type of contact details contained in the value element (http://fhir.nhs.net/ValueSet/guardian-role-type-1)
Binding Strength Required
Example Value 12

......display1..1StringRepresentation defined by the system
Example Value Mother

.....text0..1StringPlain text representation of the concept

....name0..1HumanNameA name associated with the contact person

.....use0..1Codeusual | official | temp | nickname | anonymous | old | maiden
Binding The use of a human name (http://hl7.org/fhir/ValueSet/name-use)
Binding Strength Required

.....family0..1StringFamily name (often called 'Surname')
Example Value Smith

.....given0..*StringGiven names (not always 'first'). Includes middle names
Example Value John

.....prefix0..1StringParts that come before the name

.....suffix0..*StringParts that come after the name

.....period0..1PeriodTime period when name was/is in use

......start0..1DateTimeStarting time with inclusive boundary

......end0..1DateTimeEnd time with inclusive boundary, if not ongoing

....telecom0..*ContactPointA contact detail for the person

.....system1..1Codephone | fax | email | pager | other
Binding Telecommunications form for contact point (http://hl7.org/fhir/ValueSet/contact-point-system)
Binding Strength Required
Example Value phone

.....value1..1StringThe actual contact point details
Example Value +44 191 4028507

.....use0..1Codehome | work | temp | old | mobile - purpose of this contact point
Binding Use of contact point (http://hl7.org/fhir/ValueSet/contact-point-use)
Binding Strength Required
Example Value home

.....period0..1PeriodTime period when the contact point was/is in use

......start0..1DateTimeStarting time with inclusive boundary

......end0..1DateTimeEnd time with inclusive boundary, if not ongoing

....address0..1AddressAddress for the contact person

.....use0..1Codehome | work | temp | old - purpose of this address
Binding The use of an address (http://hl7.org/fhir/ValueSet/address-use)
Binding Strength Required
Example Value home

.....type0..1Codepostal | physical | both
Binding The type of an address (physical / postal) (http://hl7.org/fhir/ValueSet/address-type)
Binding Strength Required
Example Value both

.....text0..1StringText representation of the address
Example Value 137 Nowhere Street, Erewhon 9132

.....line0..*StringStreet name, number, direction & P.O. Box etc.
Example Value 12 Taragon Square

.....city0..1StringName of city, town etc.
Example Value Leeds

.....district0..1StringDistrict name (aka county)
Example Value Madison

.....postalCode0..1StringPostal code for area
Example Value LS16 7SL

.....country0..1StringCountry (can be ISO 3166 3 letter code)

.....period0..1PeriodTime period when address was/is in use
Example Value Hl7.Fhir.Model.Period

......start0..1DateTimeStarting time with inclusive boundary

......end0..1DateTimeEnd time with inclusive boundary, if not ongoing

....organization0..1Reference (cofe-guardian-organization-1)Organization that is associated with the contact

.....reference0..1StringRelative URL reference

.....display0..1StringText alternative for the resource

...communication0..*BackboneElementA list of Languages which may be used to communicate with the patient about his or her health

....language1..1CodeableConceptThe language which can be used to communicate with the patient about his or her health
Binding A human language. (http://fhir.nhs.net/ValueSet/human-language-1)
Binding Strength Required

.....Extension Language Ability Proficiency0..1ExtensionThe level at which the patient can communicate in the specified langauge
Extension http://fhir.nhs.net/StructureDefinition/extension-cofe-language-ability-proficiency-1

.....Extension Language Ability Mode0..1ExtensionThe mode in which communication is made
Extension http://fhir.nhs.net/StructureDefinition/extension-cofe-language-ability-mode-1

.....coding0..1CodingCode defined by a terminology system
Binding A language used by human beings (http://fhir.nhs.net/ValueSet/human-language-1)
Binding Strength Required

......code1..1CodeSymbol in syntax defined by the system
Binding A language used by human beings (http://fhir.nhs.net/ValueSet/human-language-1)
Binding Strength Required
Example Value EN

....preferred0..1BooleanLanguage preference indicator

.....Null Flavor0..1ExtensionA nullFlavor can be used instead of true or false to allow assertion of things like "patient was not asked
Extension http://hl7.org/fhir/StructureDefinition/iso21090-nullFlavor

...careProvider0..*Reference (cofe-provider-organization-1 | cofe-practitioner-1)Patient's nominated primary care provider

Name Type Description & Constraints
. . Extension-COFE-Religious-Affiliation-1 Extension An extension to represent a persons religious affiliation.
. . Extension-COFE-Ethnic-Category-1 Extension An extension to represent the ethnicity of a person.
. . birthPlace Extension An extension to represent the patients birth place.
. . patient-birthTime Extension An extension to represent the patients birth time.
. . Extension-COFE-NHS-Number-Verification-Status-1 Extension An extension to represent the NHS Number verification status.
. . Extension-COFE-Guardian-Identifier-1 Extension An extension to emable the identification of the guardian using the NHS number, or a local identifier if the NHS number is not available
. . Extension-COFE-Language-Ability-Proficiency-1 Extension An extension to represent a persons language ability proficiency.
. . Extension-COFE-Language-Ability-Mode-1 Extension An extension to represent a persons language ability mode.
. . iso21090-nullFlavor Extension An extension to represent a nullFlavor
Path Name Binding Strength ValueSet
.Patient.identifier.type.coding coding Required http://fhir.nhs.net/Id/local-person-identifier
.Patient.telecom.system system Required http://hl7.org/fhir/ValueSet/contact-point-system
.Patient.telecom.use use Required http://hl7.org/fhir/ValueSet/contact-point-use
.Patient.gender gender Required http://fhir.nhs.net/ValueSet/administrative-gender-1
.Patient.maritalStatus.coding.code code Example http://fhir.nhs.net/ValueSet/marital-status-1
.Patient.contact.relationship Guardian Role Type Required http://fhir.nhs.net/ValueSet/guardian-role-type-1
.Patient.contact.relationship.coding.code code Required http://fhir.nhs.net/ValueSet/guardian-role-type-1
.Patient.communication.language language Required http://fhir.nhs.net/ValueSet/human-language-1
.Patient.communication.language.coding coding Required http://fhir.nhs.net/ValueSet/human-language-1
.Patient.communication.language.coding.code code Required http://fhir.nhs.net/ValueSet/human-language-1

COFE-Patient-1

Examples Description XML File JSON File
COFE-Patient-1-Example-1 NHS Patient Profile