Patient.extension:ethnicCategory

Ethnic category

extensions, user content

Extension(CodeableConcept)

Extension-CareConnect-EthnicCategory-1

The cardinality or value of this element may be affected by these constraints: ele-1

• 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()

• rim: n/a
• rim: N/A

Patient.extension:religiousAffiliation

Religious affiliation

extensions, user content

Extension(CodeableConcept)

Extension-CareConnect-ReligiousAffiliation-1

The cardinality or value of this element may be affected by these constraints: ele-1

• 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()

• rim: n/a
• rim: N/A

Patient.extension:patient-cadavericDonor.url

identifies the meaning of the extension

uri

The cardinality or value of this element may be affected by these constraints: ele-1

• ele-1: All FHIR elements must have a @value or children
  hasValue() | (children().count() > id.count())

http://hl7.org/fhir/StructureDefinition/patient-cadavericDonor

• rim: n/a
• rim: N/A

Patient.extension:residentialStatus

The residential status of the patient

extensions, user content

Extension(CodeableConcept)

Extension-CareConnect-ResidentialStatus-1

The cardinality or value of this element may be affected by these constraints: ele-1

• 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()

• rim: n/a
• rim: N/A

Patient.extension:treatmentCategory

The treatment category for this patient

extensions, user content

Extension(CodeableConcept)

Extension-CareConnect-TreatmentCategory-1

The cardinality or value of this element may be affected by these constraints: ele-1

• 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()

• rim: n/a
• rim: N/A

Patient.extension:nhsCommunication

NHS communication preferences for a resource

extensions, user content

Extension(Complex)

Extension-CareConnect-NHSCommunication-1

The cardinality or value of this element may be affected by these constraints: ele-1

• 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()

• rim: n/a
• rim: N/A

Patient.extension:birthPlace

Birth Place: The registered place of birth of the patient.

extensions, user content

Extension(Address)

birthPlace

The cardinality or value of this element may be affected by these constraints: ele-1

• 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()

• rim: n/a
• rim: N/A

Patient.extension:nominatedPharmacy

A patient's nominated pharmacy

extensions, user content

Extension(Reference(CareConnect-Organization-1))

Extension-CareConnect-NominatedPharmacy-1

The cardinality or value of this element may be affected by these constraints: ele-1

• 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()

• rim: n/a
• rim: N/A

Patient.extension:deathNotificationStatus

Representation of a patient’s death notification status (as held on Personal Demographics Service (PDS))

extensions, user content

Extension(Complex)

Extension-CareConnect-DeathNotificationStatus-1

The cardinality or value of this element may be affected by these constraints: ele-1

• 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()

• rim: n/a
• rim: N/A

Patient.identifier:nhsNumber.extension:nhsNumberVerificationStatus.url

identifies the meaning of the extension

uri

The cardinality or value of this element may be affected by these constraints: ele-1

• ele-1: All FHIR elements must have a @value or children
  hasValue() | (children().count() > id.count())

https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-NHSNumberVerificationStatus-1

• rim: n/a
• rim: N/A

Patient.identifier:nhsNumber.type

Description of identifier

CodeableConcept

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

Identifier Type Codes (extensible)

The cardinality or value of this element may be affected by these constraints: ele-1

• ele-1: All FHIR elements must have a @value or children
  hasValue() | (children().count() > id.count())

• rim: n/a
• v2: CE/CNE/CWE
• rim: CD
• orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
• v2: CX.5
• rim: Role.code or implied by context

Patient.identifier:nhsNumber.system

The namespace for the identifier value

uri

The cardinality or value of this element may be affected by these constraints: ele-1

• ele-1: All FHIR elements must have a @value or children
  hasValue() | (children().count() > id.count())

https://fhir.nhs.uk/Id/nhs-number

http://www.acme.com/identifiers/patient

• rim: n/a
• v2: CX.4 / EI-2-4
• rim: II.root or Role.id.root
• servd: ./IdentifierType

Patient.identifier:nhsNumber.value

The value that is unique

string

The cardinality or value of this element may be affected by these constraints: ele-1

• ele-1: All FHIR elements must have a @value or children
  hasValue() | (children().count() > id.count())

1234567890

• rim: n/a
• v2: CX.1 / EI.1
• rim: II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
• servd: ./Value

Patient.identifier:nhsNumber.period

Time period when id is/was valid for use

Period

The cardinality or value of this element may be affected by these constraints: ele-1

• ele-1: All FHIR elements must have a @value or children
  hasValue() | (children().count() > id.count())
• per-1: If present, start SHALL have a lower value than end
  start.empty() or end.empty() or (start <= end)

• rim: n/a
• v2: DR
• rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
• v2: CX.7 + CX.8
• rim: Role.effectiveTime or implied by context
• servd: ./StartDate and ./EndDate

Patient.identifier:nhsNumber.assigner

Organization that issued id (may be just text)

Reference(CareConnect-Organization-1)

The cardinality or value of this element may be affected by these constraints: ele-1

• ele-1: All FHIR elements must have a @value or children
  hasValue() | (children().count() > id.count())
• ref-1: SHALL have a contained resource if a local reference is provided
  reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

• rim: n/a
• rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
• v2: CX.4 / (CX.4,CX.9,CX.10)
• rim: II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
• servd: ./IdentifierIssuingAuthority

Patient.active

Whether this patient's record is in active use

boolean

The cardinality or value of this element may be affected by these constraints: ele-1

• ele-1: All FHIR elements must have a @value or children
  hasValue() | (children().count() > id.count())

true

• rim: n/a
• rim: statusCode
• cda: n/a
• w5: status

Patient.name:official.use

usual | official | temp | nickname | anonymous | old | maiden

code

The use of a human name

NameUse (required)

The cardinality or value of this element may be affected by these constraints: ele-1

• ele-1: All FHIR elements must have a @value or children
  hasValue() | (children().count() > id.count())

official

• rim: n/a
• v2: XPN.7, but often indicated by which field contains the name
• rim: unique(./use)
• servd: ./NamePurpose

Patient.name:official.family

Family name (often called 'Surname')

surname

string

The cardinality or value of this element may be affected by these constraints: ele-1

• ele-1: All FHIR elements must have a @value or children
  hasValue() | (children().count() > id.count())

• rim: n/a
• v2: XPN.1/FN.1
• rim: ./part[partType = FAM]
• servd: ./FamilyName

Patient.name:official.prefix

Parts that come before the name

string

The cardinality or value of this element may be affected by these constraints: ele-1

• ele-1: All FHIR elements must have a @value or children
  hasValue() | (children().count() > id.count())

• rim: n/a
• v2: XPN.5
• rim: ./part[partType = PFX]
• servd: ./TitleCode

Patient.name:official.suffix

Parts that come after the name

string

The cardinality or value of this element may be affected by these constraints: ele-1

• ele-1: All FHIR elements must have a @value or children
  hasValue() | (children().count() > id.count())

• rim: n/a
• v2: XPN/4
• rim: ./part[partType = SFX]

Patient.name:official.period

Time period when name was/is in use

Period

The cardinality or value of this element may be affected by these constraints: ele-1

• ele-1: All FHIR elements must have a @value or children
  hasValue() | (children().count() > id.count())
• per-1: If present, start SHALL have a lower value than end
  start.empty() or end.empty() or (start <= end)

• rim: n/a
• v2: DR
• rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
• v2: XPN.13 + XPN.14
• rim: ./usablePeriod[type="IVL<TS>"]
• servd: ./StartDate and ./EndDate

Patient.telecom.system

phone | fax | email | pager | url | sms | other

code

Telecommunications form for contact point

ContactPointSystem (required)

The cardinality or value of this element may be affected by these constraints: ele-1, cpt-2

• ele-1: All FHIR elements must have a @value or children
  hasValue() | (children().count() > id.count())

• rim: n/a
• v2: XTN.3
• rim: ./scheme
• servd: ./ContactPointType

Patient.telecom.value

The actual contact point details

string

The cardinality or value of this element may be affected by these constraints: ele-1

• ele-1: All FHIR elements must have a @value or children
  hasValue() | (children().count() > id.count())

• rim: n/a
• v2: XTN.1 (or XTN.12)
• rim: ./url
• servd: ./Value

Patient.telecom.use

home | work | temp | old | mobile - purpose of this contact point

code

Use of contact point

ContactPointUse (required)

The cardinality or value of this element may be affected by these constraints: ele-1

• ele-1: All FHIR elements must have a @value or children
  hasValue() | (children().count() > id.count())

• rim: n/a
• v2: XTN.2 - but often indicated by field
• rim: unique(./use)
• servd: ./ContactPointPurpose

Patient.telecom.rank

Specify preferred order of use (1 = highest)

positiveInt

The cardinality or value of this element may be affected by these constraints: ele-1

• ele-1: All FHIR elements must have a @value or children
  hasValue() | (children().count() > id.count())

• rim: n/a
• v2: n/a

Patient.telecom.period

Time period when the contact point was/is in use

Period

The cardinality or value of this element may be affected by these constraints: ele-1

• ele-1: All FHIR elements must have a @value or children
  hasValue() | (children().count() > id.count())
• per-1: If present, start SHALL have a lower value than end
  start.empty() or end.empty() or (start <= end)

• rim: n/a
• v2: DR
• rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
• v2: N/A
• rim: ./usablePeriod[type="IVL<TS>"]
• servd: ./StartDate and ./EndDate

Patient.birthDate.extension:patient-birthTime.url

identifies the meaning of the extension

uri

The cardinality or value of this element may be affected by these constraints: ele-1

• ele-1: All FHIR elements must have a @value or children
  hasValue() | (children().count() > id.count())

http://hl7.org/fhir/StructureDefinition/patient-birthTime

• rim: n/a
• rim: N/A

boolean

dateTime

Patient.address.use

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

code

The use of an address

AddressUse (required)

The cardinality or value of this element may be affected by these constraints: ele-1

• ele-1: All FHIR elements must have a @value or children
  hasValue() | (children().count() > id.count())

home

• rim: n/a
• v2: XAD.7
• rim: unique(./use)
• servd: ./AddressPurpose

Patient.address.type

postal | physical | both

code

The type of an address (physical / postal)

AddressType (required)

The cardinality or value of this element may be affected by these constraints: ele-1

• ele-1: All FHIR elements must have a @value or children
  hasValue() | (children().count() > id.count())

both

• rim: n/a
• v2: XAD.18
• rim: unique(./use)
• vcard: address type parameter

Patient.address.text

Text representation of the address

string

The cardinality or value of this element may be affected by these constraints: ele-1

• ele-1: All FHIR elements must have a @value or children
  hasValue() | (children().count() > id.count())

42 Grove Street, Overtown, West Yorkshire, LS21 1PF

• rim: n/a
• v2: XAD.1 + XAD.2 + XAD.3 + XAD.4 + XAD.5 + XAD.6
• rim: ./formatted
• vcard: address label parameter

Patient.address.line

Street name, number, direction & P.O. Box etc.

string

The cardinality or value of this element may be affected by these constraints: ele-1

• ele-1: All FHIR elements must have a @value or children
  hasValue() | (children().count() > id.count())

42 Grove Street

• rim: n/a
• v2: XAD.1 + XAD.2 (note: XAD.1 and XAD.2 have different meanings for a company address than for a person address)
• rim: AD.part[parttype = AL]
• vcard: street
• servd: ./StreetAddress (newline delimitted)

Patient.address.city

Name of city, town etc.

Municpality

string

The cardinality or value of this element may be affected by these constraints: ele-1

• ele-1: All FHIR elements must have a @value or children
  hasValue() | (children().count() > id.count())

Overtown

• rim: n/a
• v2: XAD.3
• rim: AD.part[parttype = CTY]
• vcard: locality
• servd: ./Jurisdiction

Patient.address.district

District name (aka county)

County

string

The cardinality or value of this element may be affected by these constraints: ele-1

• ele-1: All FHIR elements must have a @value or children
  hasValue() | (children().count() > id.count())

West Yorkshire

• rim: n/a
• v2: XAD.9
• rim: AD.part[parttype = CNT | CPA]

Patient.address.state

Sub-unit of country (abbreviations ok)

Province, Territory

string

The cardinality or value of this element may be affected by these constraints: ele-1

• ele-1: All FHIR elements must have a @value or children
  hasValue() | (children().count() > id.count())

• rim: n/a
• v2: XAD.4
• rim: AD.part[parttype = STA]
• vcard: region
• servd: ./Region

Patient.address.postalCode

Postal code for area

Zip

string

The cardinality or value of this element may be affected by these constraints: ele-1

• ele-1: All FHIR elements must have a @value or children
  hasValue() | (children().count() > id.count())

LS21 1PF

• rim: n/a
• v2: XAD.5
• rim: AD.part[parttype = ZIP]
• vcard: code
• servd: ./PostalIdentificationCode

Patient.address.country

Country (e.g. can be ISO 3166 2 or 3 letter code)

string

The cardinality or value of this element may be affected by these constraints: ele-1

• ele-1: All FHIR elements must have a @value or children
  hasValue() | (children().count() > id.count())

GBR

• rim: n/a
• v2: XAD.6
• rim: AD.part[parttype = CNT]
• vcard: country
• servd: ./Country

Patient.address.period

Time period when address was/is in use

Period

The cardinality or value of this element may be affected by these constraints: ele-1

• ele-1: All FHIR elements must have a @value or children
  hasValue() | (children().count() > id.count())
• per-1: If present, start SHALL have a lower value than end
  start.empty() or end.empty() or (start <= end)

{
  "start": "2010-03-23",
  "end": "2010-07-01"
}

• rim: n/a
• v2: DR
• rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
• v2: XAD.12 / XAD.13 + XAD.14
• rim: ./usablePeriod[type="IVL<TS>"]
• servd: ./StartDate and ./EndDate

Patient.maritalStatus.coding.system

Identity of the terminology system

uri

The cardinality or value of this element may be affected by these constraints: ele-1

• ele-1: All FHIR elements must have a @value or children
  hasValue() | (children().count() > id.count())

http://hl7.org/fhir/v3/MaritalStatus

• rim: n/a
• v2: C*E.3
• rim: ./codeSystem
• orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem

Patient.maritalStatus.coding.version

Version of the system - if relevant

string

The cardinality or value of this element may be affected by these constraints: ele-1

• ele-1: All FHIR elements must have a @value or children
  hasValue() | (children().count() > id.count())

• rim: n/a
• v2: C*E.7
• rim: ./codeSystemVersion
• orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion

Patient.maritalStatus.coding.code

Symbol in syntax defined by the system

code

The cardinality or value of this element may be affected by these constraints: ele-1

• ele-1: All FHIR elements must have a @value or children
  hasValue() | (children().count() > id.count())

• rim: n/a
• v2: C*E.1
• rim: ./code
• orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code

Patient.maritalStatus.coding.display

Representation defined by the system

string

The cardinality or value of this element may be affected by these constraints: ele-1

• ele-1: All FHIR elements must have a @value or children
  hasValue() | (children().count() > id.count())

• rim: n/a
• v2: C*E.2 - but note this is not well followed
• rim: CV.displayName
• orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName

Patient.maritalStatus.coding.userSelected

If this coding was chosen directly by the user

boolean

The cardinality or value of this element may be affected by these constraints: ele-1

• ele-1: All FHIR elements must have a @value or children
  hasValue() | (children().count() > id.count())

• rim: n/a
• v2: Sometimes implied by being first
• rim: CD.codingRationale
• orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]

Patient.maritalStatus.text

Plain text representation of the concept

string

The cardinality or value of this element may be affected by these constraints: ele-1

• ele-1: All FHIR elements must have a @value or children
  hasValue() | (children().count() > id.count())

• rim: n/a
• v2: C*E.9. But note many systems use C*E.2 for this
• rim: ./originalText[mediaType/code="text/plain"]/data
• orim: fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText

boolean

integer

Patient.photo

Image of the patient

Attachment

The cardinality or value of this element may be affected by these constraints: ele-1

• ele-1: All FHIR elements must have a @value or children
  hasValue() | (children().count() > id.count())
• att-1: It the Attachment has data, it SHALL have a contentType
  data.empty() or contentType.exists()

• rim: n/a
• v2: ED/RP
• rim: ED
• v2: OBX-5 - needs a profile
• rim: player[classCode=PSN|ANM and determinerCode=INSTANCE]/desc
• cda: n/a

Patient.contact.relationship

The kind of relationship

CodeableConcept

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

v2 Contact Role (extensible)

The cardinality or value of this element may be affected by these constraints: ele-1

• ele-1: All FHIR elements must have a @value or children
  hasValue() | (children().count() > id.count())

• rim: n/a
• v2: CE/CNE/CWE
• rim: CD
• orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
• v2: NK1-7, NK1-3
• rim: code
• cda: n/a

Patient.contact.name.use

usual | official | temp | nickname | anonymous | old | maiden

code

The use of a human name

NameUse (required)

The cardinality or value of this element may be affected by these constraints: ele-1

• ele-1: All FHIR elements must have a @value or children
  hasValue() | (children().count() > id.count())

• rim: n/a
• v2: XPN.7, but often indicated by which field contains the name
• rim: unique(./use)
• servd: ./NamePurpose

Patient.contact.name.text

Text representation of the full name

string

The cardinality or value of this element may be affected by these constraints: ele-1

• ele-1: All FHIR elements must have a @value or children
  hasValue() | (children().count() > id.count())

• rim: n/a
• v2: implied by XPN.11
• rim: ./formatted

Patient.contact.name.family

Family name (often called 'Surname')

surname

string

The cardinality or value of this element may be affected by these constraints: ele-1

• ele-1: All FHIR elements must have a @value or children
  hasValue() | (children().count() > id.count())

• rim: n/a
• v2: XPN.1/FN.1
• rim: ./part[partType = FAM]
• servd: ./FamilyName

Patient.contact.name.given

Given names (not always 'first'). Includes middle names

first name, middle name

string

The cardinality or value of this element may be affected by these constraints: ele-1

• ele-1: All FHIR elements must have a @value or children
  hasValue() | (children().count() > id.count())

• rim: n/a
• v2: XPN.2 + XPN.3
• rim: ./part[partType = GIV]
• servd: ./GivenNames

Patient.contact.name.prefix

Parts that come before the name

string

The cardinality or value of this element may be affected by these constraints: ele-1

• ele-1: All FHIR elements must have a @value or children
  hasValue() | (children().count() > id.count())

• rim: n/a
• v2: XPN.5
• rim: ./part[partType = PFX]
• servd: ./TitleCode

Patient.contact.name.suffix

Parts that come after the name

string

The cardinality or value of this element may be affected by these constraints: ele-1

• ele-1: All FHIR elements must have a @value or children
  hasValue() | (children().count() > id.count())

• rim: n/a
• v2: XPN/4
• rim: ./part[partType = SFX]

Patient.contact.name.period

Time period when name was/is in use

Period

The cardinality or value of this element may be affected by these constraints: ele-1