CDA On FHIR England - Document Header

CareConnect-Patient-1

The Patient resource carries the patient demographic details.

NameCard.TypeDescription & Constraints
..PatientPatientThis Patient resource is constrained for the Care Connect API interaction requirements

...registrationDetails0..1ExtensionAdditional registration information for the Patient resource
Extension http://fhir.nhs.net/StructureDefinition/extension-registration-details-1

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

...ethnicCategory0..1ExtensionEthnicity of the patient
Extension http://fhir.nhs.net/StructureDefinition/extension-ethnic-category-1

...religiousAffiliation0..1ExtensionThe religion as specified by the patient
Extension http://fhir.nhs.net/StructureDefinition/extension-religious-affiliation-snct-1

...organDonor0..1ExtensionAn indicator that the patient is listed as an organ donor.
Extension http://fhir.nhs.net/StructureDefinition/extension-organ-donor-1

...residentialStatus0..1ExtensionThe residential status of the patient.
Extension http://fhir.nhs.net/StructureDefinition/extension-residential-status-1

...treatmentCategory0..1ExtensionThe treatment category for this patient.
Extension http://fhir.nhs.net/StructureDefinition/extension-treatment-category-1

...nhsCommunication0..*ExtensionNHS communication preferences for a resource
Extension http://fhir.nhs.net/StructureDefinition/extension-nhs-communication-1

...identifierAn identifier for this patient
Slice: Ordering: Unordered, Discriminator: system, Rules: Open at End

...identifier (NHSNumber)0..1IdentifierAn NHS Number identifier for this patient

....nhsNumberVerificationStatus0..1ExtensionNHS number verification status
Extension http://fhir.nhs.net/StructureDefinition/extension-nhsnumberverificationstatus-1

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

....value1..1StringThe value that is unique
Example Value 9900002831

...identifier (other)0..*IdentifierAn 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

....type0..1CodeableConceptDescription of identifier
Binding A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. (http://hl7.org/fhir/ValueSet/identifier-type)
Binding Strength Extensible

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

......system0..1UriIdentity of the terminology system

......version0..1StringVersion of the system - if relevant

......code0..1CodeSymbol in syntax defined by the system

......display0..1StringRepresentation defined by the system

......userSelected0..1BooleanIf this coding was chosen directly by the user

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

....system0..1UriThe namespace for the identifier
Example Value http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri

....value0..1StringThe value that is unique
Example Value 123456

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

....assigner0..1Reference (careconnect-organization-1)Organization that issued id (may be just text)

.....reference0..1StringRelative, internal or absolute URL reference

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

...active0..1BooleanWhether this patient's record is in active use
Default Value true

...nameA name associated with the patient
Slice: Ordering: Unordered, Rules: Open at End

...name (usual)0..1HumanNameA name associated with the patient

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

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

....family1..1StringFamily name (often called 'Surname')

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

....prefix0..*StringParts 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

...name (other)0..*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

....family1..1StringFamily name (often called 'Surname')

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

....prefix0..*StringParts 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 individual

....system1..1Codephone | fax | email | url
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 0113-245-1919

....use0..1Codehome | work | temp | old | mobile - purpose of this contact point
Binding Use of contact point (http://hl7.org/fhir/DSTU2/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..1CodeGender for administrative purposes
Binding The gender of a person used for administrative purposes. (http://fhir.nhs.net/ValueSet/administrative-gender-1)
Binding Strength Required
Example Value female

...birthDate1..1DateThe date of birth for the patient

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

...address0..*AddressAddress details 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

....text0..1StringText representation of the address
Example Value 42 Grove Street, Overtown, West Yorkshire, LS21 1PF

....line0..*StringStreet name, number etc.
Example Value 42, Grove Street

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

....district0..1StringDistrict name (aka county)
Example Value West Yorkshire

....postalCode0..1StringPostal code for area
Example Value LS21 1PF

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

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

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

....coding0..1CodingA code taken from the marital status list of codes.

.....system1..1UriIdentity of the terminology system
Fixed Value http://hl7.org/fhir/ValueSet/marital-status

.....version0..1StringVersion of the system - if relevant

.....code1..1CodeSymbol in syntax defined by the system
Example Value M

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

.....userSelected0..1BooleanIf this coding was chosen directly by the user

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

...multipleBirth[x]0..1Boolean | IntegerWhether patient is part of a multiple birth

...contact0..*BackboneElementA contact (e.g. guardian, partner, friend) for the patient

....relationship0..*CodeableConceptThe kind of relationship to the patient
Binding The kind of relationship to the patient (http://fhir.nhs.net/ValueSet/cda-person-relationship-type-1)
Binding Strength Required

.....coding0..1CodingA code taken from the CDA Person Relationship Type list of codes.
Binding A code taken from the CDA Person Relationship Type list of codes. (http://fhir.nhs.net/ValueSet/cda-person-relationship-type-1)
Binding Strength Required

......system1..1UriIdentity of the terminology system
Fixed Value http://fhir.nhs.net/ValueSet/cda-person-relationship-type-1

......version0..1StringVersion of the system - if relevant

......code1..1CodeSymbol in syntax defined by the system
Example Value 43

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

......userSelected0..1BooleanIf this coding was chosen directly by the user

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

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

.....family1..1StringFamily name (often called 'Surname')
Example Value Taylor

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

.....prefix0..*StringParts that come before the name
Example Value Miss

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

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

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

.....value0..1StringThe actual contact point details
Example Value 0113-245-0909

.....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 120, Grove Street, Overtown, West Yorkshire, LS21 1PT

.....line0..*StringStreet name, number etc
Example Value 120, Grove Street

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

.....district0..1StringDistrict name (aka county)
Example Value West Yorkshire

.....postalCode0..1StringPostal code for area
Example Value LS21 1PT

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

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

....gender0..1CodeGender for administrative purposes
Binding The gender of a person used for administrative purposes (http://fhir.nhs.net/ValueSet/administrative-gender-1)
Binding Strength Required
Example Value female

....organization0..1Reference (careconnect-organization-1)Organization that is associated with the contact for the patient

.....reference0..1StringRelative URL reference to the Organization resource

.....display0..1StringNarrative text for the resource

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

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

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

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

...managingOrganization0..1Reference (careconnect-organization-1)Organization that is the custodian of the patient record

....reference0..1StringRelative URL reference to the Organization resource

....display0..1StringNarrative text for the resource

...link0..*BackboneElementLink to another patient resource that concerns the same actual person

....other1..1Reference (careconnect-patient-1)The other patient resource that the link refers to

.....reference0..1StringRelative, internal or absolute URL reference

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

....type1..1Codereplace | refer | seealso - type of link
Binding The type of link between this patient resource and another patient resource. (http://hl7.org/fhir/ValueSet/link-type)
Binding Strength Required

Name Type Description & Constraints
. . Extension-Registration-Details-1 Extension This extension is defined to support the additional registration information recorded by the healthcare organization for the Patient resource.
. . Patient-BirthTime Extension This Extension resource is constrained to support the patients birth time.
. . Extension-Ethnic-Category-1 Extension This Extension resource is constrained to support the ethnic category for the Patient resource.
. . Extension-Religious-Affiliation-SnCT-1 Extension This Extension resource is constrained to support the religious affiliation for the Patient resource.
. . Extension-Organ-Donor-1 Extension This Extension resource is constrained to support the organ donor status for the Patient resource.
. . Extension-Residential-Status-1 Extension This Extension resource is constrained to support the residential status for the Patient resource.
. . Extension-Treatment-Category-1 Extension This Extension resource is constrained to support the treatment category for the Patient resource.
. . Extension-NHS-Communication-1 Extension This extension is defined to support communication in the NHS for a resource.
. . Extension-NHSNumberVerificationStatus-1 Extension This Extension resource is constrained to support the NHS number verification status for the Patient resource.

CareConnect-Patient-1

Examples Description XML File
COFE-Patient-1-Example-2 NHS Patient example