Patient.identifier.use

usual | official | temp | secondary (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() | (children().count() > id.count())

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

Patient.identifier.type.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())

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

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

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

http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri

• 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

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

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

Starting time with inclusive boundary

dateTime

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

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

• rim: n/a
• v2: DR.1
• rim: ./low

Patient.identifier.period.end

End time with inclusive boundary, if not ongoing

dateTime

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

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

• rim: n/a
• v2: DR.2
• rim: ./high

Patient.identifier.assigner.reference

Literal reference, Relative, internal or absolute URL

string

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

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

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

Patient.identifier.assigner.identifier

Logical reference, when literal reference is not known

Identifier

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: CX / EI (occasionally, more often EI maps to a resource id or a URL)
• rim: II - see see identifier pattern at http://wiki.hl7.org/index.php?title=Common_Design_Patterns#Identifier_Pattern for relevant discussion. The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
• servd: Identifier
• rim: .identifier

Patient.identifier.assigner.display

Text alternative for the resource

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
• rim: N/A

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.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.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.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.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.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.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.name.period.start

Starting time with inclusive boundary

dateTime

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

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

• rim: n/a
• v2: DR.1
• rim: ./low

Patient.name.period.end

End time with inclusive boundary, if not ongoing

dateTime

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

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

• rim: n/a
• v2: DR.2
• rim: ./high

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

Starting time with inclusive boundary

dateTime

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

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

• rim: n/a
• v2: DR.1
• rim: ./low

Patient.telecom.period.end

End time with inclusive boundary, if not ongoing

dateTime

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

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

• rim: n/a
• v2: DR.2
• rim: ./high

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

• rim: n/a
• v2: PID-8
• rim: player[classCode=PSN|ANM and determinerCode=INSTANCE]/administrativeGender
• cda: .patient.administrativeGenderCode

Patient.birthDate

The date of birth for the individual

date

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: PID-7
• rim: player[classCode=PSN|ANM and determinerCode=INSTANCE]/birthTime
• cda: .patient.birthTime
• loinc: 21112-8

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

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

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

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

Patient.address.period.start

Starting time with inclusive boundary

dateTime

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

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

• rim: n/a
• v2: DR.1
• rim: ./low

Patient.address.period.end

End time with inclusive boundary, if not ongoing

dateTime

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

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

• rim: n/a
• v2: DR.2
• rim: ./high

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

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

Mime type of the content, with charset etc.

code

The mime type of an attachment. Any valid mime type is allowed.

http://www.rfc-editor.org/bcp/bcp13.txt (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())

text/plain; charset=UTF-8, image/png

• rim: n/a
• v2: ED.2+ED.3/RP.2+RP.3. Note conversion may be needed if old style values are being used
• rim: ./mediaType, ./charset

Patient.photo.language

Human language of the content (BCP-47)

code

A human language.

Common Languages (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())

en-AU

• rim: n/a
• rim: ./language

Patient.photo.data

Data inline, base64ed

base64Binary

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