Digital Child Health Service - Events Catalogue

CareConnect-DCH-Baby-Patient-1

The Patient resource represents the patient involved in the provision of healthcare related services, with further constraints applied to represent a baby as the subject of a birth event.

NameCard.TypeDescription & Constraints
..PatientPatientThe Patient resource carries the patient demographic details.

...id0..1IdLogical id of this artifact

...meta0..1MetaMetadata about the resource

...implicitRules0..1UriA set of rules under which this content was created

...language0..1CodeLanguage of the resource content
Binding A human language. (http://tools.ietf.org/html/bcp47)
Binding Strength Required

...text0..1NarrativeText summary of the resource, for human interpretation

...contained0..*ResourceContained, inline Resources

...registrationDetails0..1ExtensionAdditional registration information for the Patient resource
Extension https://fhir.hl7.org.uk/StructureDefinition/Extension-CareConnect-RegistrationDetails-1

...ethnicCategory0..1ExtensionEthnic category
Extension https://fhir.hl7.org.uk/StructureDefinition/Extension-CareConnect-EthnicCategory-1

...religiousAffiliation0..1ExtensionReligious affiliation
Extension https://fhir.hl7.org.uk/StructureDefinition/Extension-CareConnect-ReligiousAffiliation-1

...patient-cadavericDonor0..1ExtensionFlag indicating whether the patient authorized the donation of body parts after death
Extension http://hl7.org/fhir/StructureDefinition/patient-cadavericDonor

...residentialStatus0..1ExtensionThe residential status of the patient
Extension https://fhir.hl7.org.uk/StructureDefinition/Extension-CareConnect-ResidentialStatus-1

...treatmentCategory0..1ExtensionThe treatment category for this patient
Extension https://fhir.hl7.org.uk/StructureDefinition/Extension-CareConnect-TreatmentCategory-1

...nhsCommunication0..*ExtensionNHS communication preferences for a resource
Extension https://fhir.hl7.org.uk/StructureDefinition/Extension-CareConnect-NHSCommunication-1

...birthPlace0..1ExtensionThe 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.
Extension http://hl7.org/fhir/StructureDefinition/birthPlace

...identifier1..*An identifier for this patient
Slice: Ordering: Ordered, Discriminator: system, Rules: Open at End

...identifier (nhsNumber)1..1IdentifierThe patient's NHS number

....id0..1Idxml:id (or equivalent in JSON)

....nhsNumberVerificationStatus1..1ExtensionNHS number verification status
Extension https://fhir.hl7.org.uk/StructureDefinition/Extension-CareConnect-NHSNumberVerificationStatus-1

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

....value1..1StringTen numeric digit NHS number
Example Value 123456

...identifier (localIdentifier)0..*Identifier The patient's other identifiers

....id0..1Idxml:id (or equivalent in JSON)

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

.....id0..1Idxml:id (or equivalent in JSON)

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

......id0..1Idxml:id (or equivalent in JSON)

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

....system1..1UriThe namespace for the identifier
Fixed Value https://fhir.nhs.uk/Id/local-patient-identifier

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

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

.....id0..1Idxml:id (or equivalent in JSON)

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

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

....assigner0..1Reference (CareConnect-DCH-Organization-1)Organization that issued id (may be just text)

.....id0..1Idxml:id (or equivalent in JSON)

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

...name1..*A name associated with the patient
Slice: Ordering: Unordered, Discriminator: use, Rules: Open at End

...name (usual)1..1HumanNameThe patient's current usual name

....id0..1Idxml:id (or equivalent in JSON)

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

.....id0..1Idxml:id (or equivalent in JSON)

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

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

...name (other)0..*HumanNameThe patient's other names

....id0..1Idxml:id (or equivalent in JSON)

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

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

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

.....id0..1Idxml:id (or equivalent in JSON)

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

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

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

....id0..1Idxml:id (or equivalent in JSON)

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

....value1..1StringThe actual contact point details

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

....rank0..1PositiveIntSpecify preferred order of use (1 = highest)

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

.....id0..1Idxml:id (or equivalent in JSON)

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

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

...gender0..1Codemale | female | other | unknown
Binding The gender of a person used for administrative purposes. (https://fhir.hl7.org.uk/ValueSet/CareConnect-AdministrativeGender-1)
Binding Strength Required

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

....id0..1Idxml:id (or equivalent in JSON)

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

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

...address0..*AddressAddresses for the individual

....id0..1Idxml:id (or equivalent in JSON)

....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, direction & P.O. Box 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

.....id0..1Idxml:id (or equivalent in JSON)

.....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. (https://fhir.hl7.org.uk/ValueSet/CareConnect-MaritalStatus-1)
Binding Strength Required

....id0..1Idxml:id (or equivalent in JSON)

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

.....id0..1Idxml:id (or equivalent in JSON)

.....system1..1UriIdentity of the terminology system
Example Value http://hl7.org/fhir/v3/MaritalStatus

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

.....display1..1StringRepresentation defined by the system

...multipleBirthInteger1..1IntegerWhether patient is part of a multiple birth

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

....id0..1Idxml:id (or equivalent in JSON)

....relationship0..*CodeableConceptThe kind of relationship
Binding The nature of the relationship between a patient and a contact person for that patient. (http://hl7.org/fhir/ValueSet/patient-contact-relationship)
Binding Strength Extensible

.....id0..1Idxml:id (or equivalent in JSON)

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

......id0..1Idxml:id (or equivalent in JSON)

......system1..1UriIdentity of the terminology system
Example Value https://fhir.hl7.org.uk/CareConnect-PersonRelationshipType-1

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

......display1..1StringRepresentation defined by the system

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

.....id0..1Idxml:id (or equivalent in JSON)

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

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

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

......id0..1Idxml:id (or equivalent in JSON)

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

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

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

.....id0..1Idxml:id (or equivalent in JSON)

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

.....value0..1StringThe actual contact point details

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

.....rank0..1PositiveIntSpecify preferred order of use (1 = highest)

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

......id0..1Idxml:id (or equivalent in JSON)

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

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

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

.....id0..1Idxml:id (or equivalent in JSON)

.....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, direction & P.O. Box 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

......id0..1Idxml:id (or equivalent in JSON)

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

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

....gender0..1Codemale | female | other | unknown
Binding The gender of a person used for administrative purposes. (https://fhir.hl7.org.uk/ValueSet/CareConnect-AdministrativeGender-1)
Binding Strength Required

....organization0..1Reference (CareConnect-DCH-Organization-1)Organization that is associated with the contact

.....id0..1Idxml:id (or equivalent in JSON)

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

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

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

.....id0..1Idxml:id (or equivalent in JSON)

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

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

...careProvider0..1Reference (CareConnect-DCH-Organization-1 | CareConnect-DCH-Practitioner-1)Patient's nominated care provider

....id0..1Idxml:id (or equivalent in JSON)

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

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

...managingOrganization0..1Reference (CareConnect-DCH-Organization-1)Organization that is the custodian of the patient record

....id0..1Idxml:id (or equivalent in JSON)

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

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

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

....id0..1Idxml:id (or equivalent in JSON)

....other1..1Reference (CareConnect-DCH-Baby-Patient-1)The other patient resource that the link refers to

.....id0..1Idxml:id (or equivalent in JSON)

.....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-CareConnect-RegistrationDetails-1 Extension This extension is constrained to represent the additional registration information for a patient.
. . Extension-CareConnect-EthnicCategory-1 Extension This extension is constrained to represent the ethnic category for a patient.
. . Extension-CareConnect-ReligiousAffiliation-1 Extension This extension is constrained to represent the religious affiliation for a patient.
. . patient-cadavericDonor Extension Flag indicating whether the patient authorized the donation of body parts after death.
. . Extension-CareConnect-ResidentialStatus-1 Extension This extension is constrained to represent the residential status for a patient.
. . Extension-CareConnect-TreatmentCategory-1 Extension This extension is constrained to represent the treatment category for a patient.
. . Extension-CareConnect-NHSCommunication-1 Extension This extension is constrained to support the communication preferences for a resource in the NHS.
. . birthPlace Extension 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.
. . Extension-CareConnect-NHSNumberVerificationStatus-1 Extension This extension is constrained to represent the NHS Number Verification Status.
. . patient-birthTime Extension The time of day that the Patient was born. This includes the date to ensure that the timezone information can be communicated effectively.
Path Name Binding Strength ValueSet
.Patient.language language Required http://tools.ietf.org/html/bcp47
.Patient.extension residentialStatus Required https://fhir.hl7.org.uk/ValueSet/CareConnect-ResidentialStatus-1
.Patient.extension treatmentCategory Required https://fhir.hl7.org.uk/ValueSet/CareConnect-TreatmentCategory-1
.Patient.identifier.use use Required http://hl7.org/fhir/ValueSet/identifier-use
.Patient.identifier.type type Extensible http://hl7.org/fhir/ValueSet/identifier-type
.Patient.name.use use Required http://hl7.org/fhir/ValueSet/name-use
.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 https://fhir.hl7.org.uk/ValueSet/CareConnect-AdministrativeGender-1
.Patient.address.use use Required http://hl7.org/fhir/ValueSet/address-use
.Patient.address.type type Required http://hl7.org/fhir/ValueSet/address-type
.Patient.maritalStatus maritalStatus Required https://fhir.hl7.org.uk/ValueSet/CareConnect-MaritalStatus-1
.Patient.photo.contentType contentType Required http://www.rfc-editor.org/bcp/bcp13.txt
.Patient.contact.relationship relationship Extensible http://hl7.org/fhir/ValueSet/patient-contact-relationship
.Patient.animal.species species Example http://hl7.org/fhir/ValueSet/animal-species
.Patient.animal.breed breed Example http://hl7.org/fhir/ValueSet/animal-breeds
.Patient.animal.genderStatus genderStatus Example http://hl7.org/fhir/ValueSet/animal-genderstatus
.Patient.link.type type Required http://hl7.org/fhir/ValueSet/link-type