Patient.extension:aboriginalidentitygroup

Extension: Aboriginal Identity Group

extensions, user content

Extension

ExtensionAboriginalIdentityGroup

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() or (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:aboriginalidentityindicator

Extension: Aboriginal Identity Indicator

extensions, user content

Extension

ExtensionAboriginalIdentityIndicator

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() or (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:birthsex

Extension: Sex at Birth

extensions, user content

Extension

ExtensionBirthSex

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() or (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
• rim: player[classCode=PSN|ANM and determinerCode=INSTANCE]/administrativeGender
• iso11179: .patient.administrativeGenderCode

Patient.extension:ethnicity

Extension: ethnicity extension

extensions, user content

Extension

ExtensionEthnicity

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() or (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
• HL7v2: PID.22 [Ethnic Group]
• rim: Person.ethnicGroupCode
• CDA: /ClinicalDocument/recordTarget/patientRole/patient/sdtc:ethnicGroupCode

Patient.identifier.use

usual | official | temp | secondary | old (If known)

code

Identifies the purpose for this identifier, if known .

IdentifierUse (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() or (children().count() > id.count())

• rim: n/a
• v2: N/A
• rim: Role.code or implied by context

Patient.identifier.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() or (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.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() or (children().count() > id.count())

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

The value that is unique within 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() or (children().count() > id.count())

123456

• 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.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() or (children().count() > id.count())
• per-1: If present, start SHALL have a lower value than end
  start.hasValue().not() or end.hasValue().not() 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.assigner

Organization that issued id (may be just text)

Reference(Organization)

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() or (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.identifier:JHN.extension:versionCode

Health Number Version Code

extensions, user content

Extension

ExtensionIdentifierVersion

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() or (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:JHN.use

usual | official | temp | secondary | old (If known)

code

Identifies the purpose for this identifier, if known .

IdentifierUse (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() or (children().count() > id.count())

• rim: n/a
• v2: N/A
• rim: Role.code or implied by context

Patient.identifier:JHN.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() or (children().count() > id.count())

{
  "coding": [
    {
      "system": "http://terminology.hl7.org/CodeSystem/v2-0203",
      "code": "JHN"
    }
  ]
}

• 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:JHN.system

A Health Number Naming System from the Canadian URI Registry

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() or (children().count() > id.count())

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:JHN.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() or (children().count() > id.count())

123456

• 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:JHN.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() or (children().count() > id.count())
• per-1: If present, start SHALL have a lower value than end
  start.hasValue().not() or end.hasValue().not() 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:JHN.assigner

Organization that issued id (may be just text)

Reference(Organization)

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() or (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() or (children().count() > id.count())

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

Patient.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() or (children().count() > id.count())

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

Patient.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() or (children().count() > id.count())

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

Patient.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() or (children().count() > id.count())

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

Patient.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() or (children().count() > id.count())

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

Patient.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() or (children().count() > id.count())

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

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

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

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

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() or (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() or (children().count() > id.count())
• per-1: If present, start SHALL have a lower value than end
  start.hasValue().not() or end.hasValue().not() 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.address.extension:preferred

HL7 Preferred Address Flag extension

extensions, user content

Extension(boolean)

Preferred

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() or (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.address.extension:noFixedAddress

No Fixed Address indicator

extensions, user content

Extension

ExtensionNoFixedAddress

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() or (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.address.use

home | work | temp | old | billing - 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() or (children().count() > id.count())

home

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

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() or (children().count() > id.count())

137 Nowhere Street, Erewhon 9132

• 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() or (children().count() > id.count())

137 Nowhere 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() or (children().count() > id.count())

Erewhon

• 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() or (children().count() > id.count())

Madison

• 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() or (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() or (children().count() > id.count())

9132

• 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() or (children().count() > id.count())

• 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() or (children().count() > id.count())
• per-1: If present, start SHALL have a lower value than end
  start.hasValue().not() or end.hasValue().not() 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

Marital (civil) status of a patient

CodeableConcept

The domestic partnership status of a person.

Marital Status 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() or (children().count() > id.count())

• rim: n/a
• v2: CE/CNE/CWE
• rim: CD
• orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
• v2: PID-16
• rim: player[classCode=PSN]/maritalStatusCode
• cda: .patient.maritalStatusCode

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() or (children().count() > id.count())
• att-1: If 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.

PatientContactRelationship (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() or (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

A name associated with the contact person

HumanName

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() or (children().count() > id.count())

• rim: n/a
• v2: XPN
• rim: EN (actually, PN)
• servd: ProviderName
• v2: NK1-2
• rim: name
• cda: n/a

Patient.contact.telecom

A contact detail for the person

ContactPoint

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() or (children().count() > id.count())
• cpt-2: A system is required if a value is provided.
  value.empty() or system.exists()

• rim: n/a
• v2: XTN
• rim: TEL
• servd: ContactPoint
• v2: NK1-5, NK1-6, NK1-40
• rim: telecom
• cda: n/a

Patient.contact.address

Address for the contact person

Address

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() or (children().count() > id.count())

• rim: n/a
• v2: XAD
• rim: AD
• servd: Address
• v2: NK1-4
• rim: addr
• cda: n/a

Patient.contact.gender

male | female | other | unknown

code

The gender of a person used for administrative purposes.

AdministrativeGender (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() or (children().count() > id.count())

• rim: n/a
• v2: NK1-15
• rim: player[classCode=PSN|ANM and determinerCode=INSTANCE]/administrativeGender
• cda: n/a

Patient.contact.organization

Organization that is associated with the contact

Reference(Organization)

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

• ele-1: All FHIR elements must have a @value or children
  hasValue() or (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: NK1-13, NK1-30, NK1-31, NK1-32, NK1-41
• rim: scoper
• cda: n/a

Patient.contact.period

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

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() or (children().count() > id.count())
• per-1: If present, start SHALL have a lower value than end
  start.hasValue().not() or end.hasValue().not() or (start <= end)

• rim: n/a
• v2: DR
• rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
• rim: effectiveTime
• cda: n/a

Patient.communication.language

The language which can be used to communicate with the patient about his or her health

CodeableConcept

A human language.

CommonLanguages (preferred)

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() or (children().count() > id.count())

• rim: n/a
• v2: CE/CNE/CWE
• rim: CD
• orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
• v2: PID-15, LAN-2
• rim: player[classCode=PSN|ANM and determinerCode=INSTANCE]/languageCommunication/code
• cda: .languageCode

Patient.communication.preferred

Language preference indicator

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() or (children().count() > id.count())

• rim: n/a
• v2: PID-15
• rim: preferenceInd
• cda: .preferenceInd

Patient.generalPractitioner

Patient's nominated primary care provider

careProvider

Reference(Organization | Practitioner | PractitionerRole)