This
page
is
part
of
the
Continuous
Integration
Build
of
FHIR
Specification
(v4.0.1:
R4
-
Mixed
Normative
and
STU
)
in
it's
permanent
home
(it
will
always
(will
be
available
incorrect/inconsistent
at
this
URL).
The
current
version
which
supercedes
this
version
is
5.0.0
.
For
a
full
list
of
available
versions,
see
times).
See
the
Directory
of
published
versions
.
Page
versions:
R5
R4B
R4
R3
R2
|
Responsible
Owner:
FHIR
Infrastructure
Work
Group
|
Standards Status : Informative |
This
page
includes
additional
examples
of
the
data
types,
datatypes,
based
on
common
usages
and
questions
Table
of
Contents
Datatypes
Index
A boolean true value:
<active value="true" />
A negative integer value:
<score value="-14" />
A high-precision decimal value:
<pi value="3.14159265358979323846264338327950288419716939937510" />
A stream of bytes, base64 encoded:
<data value="/9j/4...KAP//Z" /> <!-- covers many lines -->
A Unicode string:
<caption value="Noodles are called ?? in Chinese" />
A URI that points to a website:
<reference value="http://hl7.org/fhir" />
A URI that is a urn:
<id value="urn:isbn:0451450523" />
A date of birth:
<date value="1951-06-04" />
An approximate date of birth:
<date value="1951-06" />
The
instant
a
document
was
created,
including
time
zone:
timezone:
<instant value="2013-06-08T10:57:34+01:00" />
The instant a document was created, expressed in UTC, with milliseconds:
<instant value="2013-06-08T09:57:34.2112Z" />
2:35pm in the afternoon:
<timevalue="14:35"value="14:35:00" />
A boolean true value:
"active" : true
A negative integer value:
"score" : -14
A high-precision decimal value:
"pi" : 3.14159265358979323846264338327950288419716939937510
A stream of bytes, base64 encoded:
"data" : "/9j/4...KAP//Z" "!-- covers many lines -->
A Unicode string:
"caption" : "Noodles are called ?? in Chinese"
A URI that points to a website:
"reference" : "http://hl7.org/fhir"
A URI that is a urn:
"id" : "urn:isbn:0451450523"
A date of birth:
"date" : "1951-06-04"
An approximate date of birth:
"date" : "1951-06"
The instant a document was created, including timezone:
"instant" : "2013-06-08T10:57:34+01:00"
The instant a document was created, expressed in UTC, with milliseconds:
"instant" : "2013-06-08T09:57:34.2112Z"
2:35pm in the afternoon:
"time" : "14:35:00"
A URI that is the root oid of HL7:
<root value="urn:oid:2.16.840.1.113883" />
A URI that is a uuid:
<id value="urn:uuid:a5afddf4-e880-459b-876e-e4591b0acc11" />
A code:
<code value="acq4+acq5" />
A code with single internal space:
<code value="Question 4b" />
A numeric id:
<id value="314" />
An alphanumeric id:
<id value="alpha-gamma-14" />
A URI that is the root oid of HL7:
"root" : "urn:oid:2.16.840.1.113883"
A URI that is a uuid:
"id" : "urn:uuid:a5afddf4-e880-459b-876e-e4591b0acc11"
A code:
"code" : "acq4+acq5"
A code with single internal space:
"code" : "Question 4b"
A numeric id:
"id" : "314"
An alphanumeric id:
"id" : "alpha-gamma-14"
A text representation of a date:
Foundation
<birthDate id="314159" value="1970-03-30" >
<extension url="http://example.org/fhir/StructureDefinition/text">
<valueString value="Easter 1970"/>
</extension>
</birthDate>
"birthDate": "1970-03-30",
"_birthDate": {
"id": "314159",
"extension" : [ {
"url" : "http://example.org/fhir/StructureDefinition/text",
"valueString" : "Easter 1970"
}]
}
See
also
Base
Definition
,
Detailed
Descriptions
,
Mappings
,
Profiles
&
Extensions
and
R2
Conversions
.
Extensions
A PDF document:
<document>
<contentType value="application/pdf" />
<language value="en" />
<data value="/9j/4...KAP//Z" /> <!-- covers many lines -->
<title value="Definition of Procedure" />
</document>
"document" : {
"contentType" : "application/pdf",
"language" : "en",
"data" : "/9j/4...KAP//Z",
"title" : "Definition of Procedure"
}
Since the JSON examples have the same structure as the XML, only XML is shown for the rest of the examples.
A reference to a DICOM image via WADO:
<image>
<contentType value="application/dicom" />
<url value="http://10.1.2.3:1000/wado?requestType=WADO&wado_details..." />
<hash value="EQH/..AgME" />
</image>
"image" : {
"contentType" : "application/dicom",
"url" : "http://10.1.2.3:1000/wado?requestType=WADO&wado_details...",
"hash" : "EQH/..AgME"
}
See
also
Base
Definition
,
Detailed
Descriptions
,
Mappings
,
Profiles
&
Extensions
and
R2
Conversions
.
Extensions
Examples
A primary key from an application table (an OID in the space allocated by HL7 to some organization to further sub-allocate):
<identifier>
<use value="official" />
<system value="urn:oid:2.16.840.1.113883.16.4.3.2.5" />
<value value="123" />
</identifier>
"identifier" : {
"use" : "official",
"system" : "urn:oid:2.16.840.1.113883.16.4.3.2.5",
"value" : "123"
}
A patient identifier defined by a hospital:
<identifier>
<use value="official" />
<system value="http://www.acmehosp.com/patients" />
<value value="44552" />
<period>
<start value="2003-05-03" />
</period>
</identifier>
"identifier" : {
"use" : "official",
"system" : "http://www.acmehosp.com/patients",
"value" : "44552",
"period" : {
"start" : "2003-05-03"
}
}
In this case, the period is used to track when the identifier was first assigned to the patient.
An identifier that refers to a patient FHIR resource on a particular system:
<identifier><system value="urn:ietf:rfc:3986" /> <value value="http://pas-server/xxx/Patient/443556" /><system value="urn:ietf:rfc:3986" /> <value value="http://pas-server/xxx/Patient/443556" /> </identifier>
"identifier" : {
"system" : "urn:ietf:rfc:3986",
"value" : "http://pas-server/xxx/Patient/443556"
}
This is not a resource reference - it's a logical reference by the patient identifier.
A UUID:
<identifier>
<use value="temp" />
<system value="urn:ietf:rfc:3986" />
<value value="urn:uuid:a76d9bbf-f293-4fb7-ad4c-2851cac77162" />
</identifier>
"identifier" : {
"use" : "temp",
"system" : "urn:ietf:rfc:3986",
"value" : "urn:uuid:a76d9bbf-f293-4fb7-ad4c-2851cac77162"
}
UUIDs are often used for temporary identifiers, though this is not necessary.
A DICOM OID:
<identifier>
<system value="urn:dicom:uid" />
<value value="urn:oid:2.16.124.113543.6003.189642796.63084.16748.2599092901" />
</identifier>
"identifier" : {
"system" : "urn:dicom:uid",
"value" : "urn:oid:2.16.124.113543.6003.189642796.63084.16748.2599092901"
}
The
system
value
urn:dicom:uid
can
be
used
for
any
OID
issued
under
the
DICOM
arrangements
for
OIDs.
Such
OIDs
are
typically
found
in
DICOM
messages,
but
this
is
not
a
requirement
for
using
urn:dicom:uid
A US SSN:
<identifier>
<use value="usual" />
<type>
<coding>
<system value="http://terminology.hl7.org/CodeSystem/v2-0203"/>
<code value="SSN"/>
</coding>
</type>
<system value="http://hl7.org/fhir/sid/us-ssn" />
<value value="000111111" />
</identifier>
"identifier" : {
"use" : "usual",
"type" : {
"coding" : [{
"system" : "http://terminology.hl7.org/CodeSystem/v2-0203",
"code" : "SSN"
}]
},
"system" : "http://hl7.org/fhir/sid/us-ssn",
"value" : "000111111"
}
A bank card with Identifier.type.text communicating the human readable name of the identifier:
<identifier>
<use value="usual" />
<type>
<coding>
<system value="http://terminology.hl7.org/CodeSystem/v2-0203"/>
<code value="BC"/>
</coding>
<text value="Visa"/>
</type>
<value value="4111111111111111" />
</identifier>
"identifier" : {
"use" : "usual",
"type" : {
"coding" : [{
"system" : "http://terminology.hl7.org/CodeSystem/v2-0203",
"code" : "BC"
}],
"text" : "Visa"
},
"value" : "4111111111111111"
}
Notes:
A medical record number assigned on 5-July 2009:
<identifier>
<use value="usual" />
<type>
<coding>
<system value="http://terminology.hl7.org/CodeSystem/v2-0203"/>
<code value="MRN"/>
</coding>
</type>
<system value="urn:oid:0.1.2.3.4.5.6.7" />
<value value="2356" />
<period>
<start value="2009-07-05" />
</period>
</identifier>
"identifier" : {
"use" : "usual",
"type" : {
"coding" : [{
"system" : "http://terminology.hl7.org/CodeSystem/v2-0203",
"code" : "MRN"
}]
},
"system" : "urn:oid:0.1.2.3.4.5.6.7",
"value" : "2356",
"period" : {
"start" : "2009-07-05"
}
}
A root only:
<v3:id root="0.1.2.3.4.5"/>
becomes:
<identifier>
<system value="urn:ietf:rfc:3986" />
<value value="urn:oid:0.1.2.3.4.5" />
</identifier>
"identifier" : {
"system" : "urn:ietf:rfc:3986",
"value" : "urn:oid:0.1.2.3.4.5"
}
A root with an extension:
<v3:id root="0.1.2.3.4.5" extension="13412"/>
becomes:
<identifier>
<system value="urn:oid:0.1.2.3.4.5" />
<value value="13412" />
</identifier>
"identifier" : {
"system" : "urn:oid:0.1.2.3.4.5",
"value" : "13412"
}
See v3 Mapping Notes
See
also
Base
Definition
,
Detailed
Descriptions
,
Mappings
,
Profiles
&
Extensions
and
R2
Conversions
.
Extensions
Examples
A simple code for headache, in ICD-10:
<code>
<system value="http://hl7.org/fhir/sid/icd-10" />
<code value="G44.1" />
</code>
"code" : {
"system" : "http://hl7.org/fhir/sid/icd-10",
"code" : "G44.1"
}
A SNOMED CT expression:
See
also
Base
Definition
,
Detailed
Descriptions
,
Mappings
,
Profiles
&
Extensions
and
R2
Conversions
.
Extensions
Examples
A simple code for headache initially coded in SNOMED CT (by picking the SNOMED CT code from a pick-list), and then translated to ICD-10:
<concept>
<coding>
<system value="http://hl7.org/fhir/sid/icd-10" />
<code value="R51" />
</coding>
<coding>
<system value="http://snomed.info/sct" />
<code value="25064002" />
<display value="Headache" />
<userSelected value="true" />
</coding>
<text value="general headache" />
</concept>
"concept" : {
"coding" : [{
"system" : "http://hl7.org/fhir/sid/icd-10",
"code" : "R51"
}, {
"system" : "http://snomed.info/sct",
"code" : "25064002",
"display" : "Headache",
"userSelected" : "true"
}],
"text" : "general headache"
}
A concept represented in an institution's local coding systems for unit for which no UCUM equivalent exists:
<unit>
<coding>
<system value="urn:oid:2.16.840.1.113883.19.5.2" />
<code value="tab" />
<display value="Tablet" />
</coding>
<coding>
<system value="http://unitsofmeasure.org" />
</coding>
</unit>
"unit" : {
"coding" : [{
"system" : "urn:oid:2.16.840.1.113883.19.5.2",
"code" : "tab",
"display" : "Tablet"
}, {
"system" : "http://unitsofmeasure.org"
}]
}
A SNOMED CT expression:
<diagnosis>
<coding>
<system value="http://snomed.info/sct" />
<code value="128045006:{363698007=56459004}" />
</coding>
<text value="Cellulitis of the foot" />
</diagnosis>
"diagnosis" : {
"coding" : [{
"system" : "http://snomed.info/sct",
"code" : "128045006:{363698007=56459004}"
}],
"text" : "Cellulitis of the foot"
}
In this case, there is no display element, because no display is defined for SNOMED CT expressions.
Using the value set:
The results on a urinalysis strip:
<valueCoding>
<system value="http://example.org/codes/simple-grades" />
<code value="+" />
</valueCoding>
"valueCoding" : {
"system" : "http://example.org/codes/simple-grades",
"code" : "+"
}
And where the value set would be something like this:
<ValueSet xmlns="http://hl7.org/fhir">
<text>
<status value="generated"/>
<div xmlns="http://www.w3.org/1999/xhtml">
<p>Possible Clinistix codes: neg, trace, +, ++, and +++</p>
</div>
</text>
<url value="http://hl7.org/fhir/ValueSet/clinistix"/>
<name value="Codes for Clinistix"/>
<publisher value="HL7"/>
<contact>
<name value="FHIR project team"/>
<telecom>
<system value="url"/>
<value value="http://hl7.org/fhir"/>
</telecom>
</contact>
<description value="Clinistix Codes"/>
<status value="draft"/>
<experimental value="true"/>
<date value="2013-10-01"/>
<compose>
<include>
<system value="http://example.org/codes/simple-grades"/>
<concept>
<code value="neg"/>
</concept>
<concept>
<code value="trace"/>
</concept>
<concept>
<code value="+"/>
</concept>
<concept>
<code value="+"/>
</concept>
<concept>
<code value="++"/>
</concept>
<concept>
<code value="+++"/>
</concept>
</include>
</compose>
</ValueSet>
{
"resourceType" : "ValueSet",
"url" : "http://hl7.org/fhir/ValueSet/clinistix",
"name" : "Codes for Clinistix",
"publisher" : "HL7",
"contact" : [{
"name" : "FHIR project team",
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
}]
}],
"description" : "Clinistix Codes",
"status" : "draft",
"experimental" : "true",
"date" : "2013-10-01",
"compose" : {
"include" : [{
"system" : "http://example.org/codes/simple-grades",
"concept" : [{
"code" : "neg"
}, {
"code" : "trace"
}, {
"code" : "+"
}, {
"code" : "+"
}, {
"code" : "++"
}, {
"code" : "+++"
}]
}]
}
}
See
also
Base
Definition
,
Detailed
Descriptions
,
Mappings
,
Profiles
&
Extensions
and
R2
Conversions
.
Extensions
Examples
A duration:
<time>
<value value="25" />
<unit value="sec" />
<system value="http://unitsofmeasure.org" />
<code value="s" />
</time>
"time" : {
"value" : "25",
"unit" : "sec",
"system" : "http://unitsofmeasure.org",
"code" : "s"
}
A concentration where the value was out of range:
<result>
<value value="40000" />
<comparator value=">" />
<unit value="mcg/L" />
<comparator value=">" />
<unit value="ug/L" />
<system value="http://unitsofmeasure.org" />
<code value="ug" />
</result>
"result" : {
"value" : "40000",
"comparator" : ">",
"unit" : "ug/L",
"system" : "http://unitsofmeasure.org",
"code" : "ug"
}
An amount of prescribed medication:
See
also
Base
Definition
,
Detailed
Descriptions
,
Mappings
,
Profiles
&
Extensions
and
R2
Conversions
.
Extensions
Examples
US Dollars:
<time>
<value value="25.00" />
<currency value="USD" />
</time>
"time" : {
"value" : "25.00",
"currency" : "USD"
}
Vietnamese Dong:
<result>
<value value="410000" />
<currency value="VND" />
</result>
"result" : {
"value" : "410000",
"currency" : "VND"
}
A quantity that represents a currency amount - used in Ratio where Money is not used:
<numerator>
<value value="25.45" />
<unit value="US$" />
<system value="urn:iso:std:iso:4217" />
<code value="USD" />
</numerator>
"numerator" : {
"value" : "25.45",
"unit" : "US$",
"system" : "urn:iso:std:iso:4217",
"code" : "USD"
}
(See full example on Ratio )
See
also
Base
Definition
,
Detailed
Descriptions
,
Mappings
,
Profiles
&
Extensions
and
R2
Conversions
.
Extensions
Examples
Range of Quantity (distance):
<estimate><low> <value value="1.6" /> <unit value="m" /> </low> <high> <value value="1.9" /> <unit value="m" /> </high><low> <value value="1.6" /> <unit value="m" /> </low> <high> <value value="1.9" /> <unit value="m" /> </high> </estimate>
"estimate" : {
"low" : {
"value" : "1.6",
"unit" : "m"
},
"high" : {
"value" : "1.9",
"unit" : "m"
}
}
See
also
Base
Definition
,
Detailed
Descriptions
,
Mappings
,
Profiles
&
Extensions
and
R2
Conversions
.
Extensions
Examples
Titer (Ratio of integer:integer)
<result><numerator> <value value="1" /> </numerator> <denominator> <value value="128" /> </denominator><numerator> <value value="1" /> </numerator> <denominator> <value value="128" /> </denominator> </result>
"result" : {
"numerator" : {
"value" : "1"
},
"denominator" : {
"value" : "128"
}
}
Unit cost (Ratio of Money(as Quantity):Quantity):
<charge><numerator> <value value="103.50" /> <unit value="US$" /> <code value="USD" /> <system value="urn:iso:std:iso:4217" /> </numerator> <denominator> <value value="1" /> <unit value="day" /> <code value="day" /> <system value="http://unitsofmeasure.org" /> </denominator><numerator> <value value="103.50" /> <unit value="US$" /> <code value="USD" /> <system value="urn:iso:std:iso:4217" /> </numerator> <denominator> <value value="1" /> <unit value="day" /> <code value="day" /> <system value="http://unitsofmeasure.org" /> </denominator> </charge>
"charge" : {
"numerator" : {
"value" : "103.50",
"unit" : "US$",
"code" : "USD",
"system" : "urn:iso:std:iso:4217"
},
"denominator" : {
"value" : "1",
"unit" : "day",
"code" : "day",
"system" : "http://unitsofmeasure.org"
}
}
See also Base Definition , Detailed Descriptions , Mappings , Profiles and Extensions
Examples
Titer (Range of Ratio of integer:integer)
<result>
<lowNumerator>
<value value="1" />
</lowNumerator>
<highNumerator>
<value value="2" />
</highNumerator>
<denominator>
<value value="128" />
</denominator>
</result>
"result" : {
"lowNumerator" : {
"value" : "1"
},
"highNumerator" : {
"value" : "2"
},
"denominator" : {
"value" : "128"
}
}
Unit cost (Range of Ratio of Money(as Quantity):Quantity):
<charge>
<lowNumerator>
<value value="103.50" />
<unit value="US$" />
<code value="USD" />
<system value="urn:iso:std:iso:4217" />
</lowNumerator>
<highNumerator>
<value value="210.99" />
<unit value="US$" />
<code value="USD" />
<system value="urn:iso:std:iso:4217" />
</highNumerator>
<denominator>
<value value="1" />
<unit value="day" />
<code value="day" />
<system value="http://unitsofmeasure.org" />
</denominator>
</charge>
"charge" : {
"lowNumerator" : {
"value" : "103.50",
"unit" : "US$",
"code" : "USD",
"system" : "urn:iso:std:iso:4217"
},
"highNumerator" : {
"value" : "210.99",
"unit" : "US$",
"code" : "USD",
"system" : "urn:iso:std:iso:4217"
},
"denominator" : {
"value" : "1",
"unit" : "day",
"code" : "day",
"system" : "http://unitsofmeasure.org"
}
}
Range of strengths
<result>
<lowNumerator>
<value value="10" />
<unit value="milliliter" />
<code value="mL" />
<system value="http://unitsofmeasure.org" />
</lowNumerator>
<highNumerator>
<value value="15" />
<unit value="milliliter" />
<code value="mL" />
<system value="http://unitsofmeasure.org" />
</highNumerator>
<denominator>
<value value="100" />
<unit value="gram" />
<code value="g" />
<system value="http://unitsofmeasure.org" />
</denominator>
</result>
"result" : {
"lowNumerator" : {
"value" : "10",
"unit" : "milliliter",
"code" : "mL",
"system" : "http://unitsofmeasure.org"
},
"highNumerator" : {
"value" : "15",
"unit" : "milliliter",
"code" : "mL",
"system" : "http://unitsofmeasure.org"
},
"denominator" : {
"value" : "100",
"unit" : "gram",
"code" : "g",
"system" : "http://unitsofmeasure.org"
}
}
See
also
Base
Definition
,
Detailed
Descriptions
,
Mappings
,
Profiles
&
Extensions
and
R2
Conversions
.
Extensions
Examples
23rd May 2011 to 27th May, including 27th May:
See
also
Base
Definition
,
Detailed
Descriptions
,
Mappings
,
Profiles
&
Extensions
and
R2
Conversions
.
Extensions
Example
The output from an EKG device:
<sampledData><origin> <value value="0"/> <unit value="μV"/> <system value="http://unitsofmeasure.org"/> <code value="uV"/> </origin> <period value="2"/> <factor value="2.5"/> <dimensions value="1"/> <data value="-4 -13 -18 -18 -18 -17 -16 -16 -16 -16 -16 -17 -18 -18 -18 ...."/><origin> <value value="0"/> <unit value="μV"/> <system value="http://unitsofmeasure.org"/> <code value="uV"/> </origin> <period value="2"/> <factor value="2.5"/> <dimensions value="1"/> <data value="-4 -13 -18 -18 -18 -17 -16 -16 -16 -16 -16 -17 -18 -18 -18 ...."/> </sampledData>
"sampledData" : {
"origin" : {
"value" : "0",
"unit" : "μV",
"system" : "http://unitsofmeasure.org",
"code" : "uV"
},
"interval" : "2",
"factor" : "2.5",
"dimensions" : "1",
"data" : "-4 -13 -18 -18 -18 -17 -16 -16 -16 -16 -16 -17 -18 -18 -18 ...."
}
See
also
Base
Definition
,
Detailed
Descriptions
,
Mappings
,
Profiles
&
Extensions
and
R2
Conversions
.
Extensions
A Simple example
<name> <family value="Everyman" /> <given value="Adam" /> <given value="A." /> </name>
"name" : {
"family" : "Everyman",
"given" : ["Adam", "A."]
}
Composite names
<name> <family value="Contrata" /> <given value="Mary Jane" /> </name><name> <family value="Contrata" /> <given value="Mary Jane" /> </name>
"name" : {
"family" : "Contrata",
"given" : ["Mary Jane"]
}
These cases can be quite ambiguous - is "Mary Jane" one name, or two? Different systems, and data enterers may treat this differently, and the person themselves might not know. Parts are allowed to contain spaces, but systems should consider how to treat these cases. Composite names separated by "-" should be treated as a single name part.
A common pattern: a person is called by a name other than that expected from their official name (first given name in most cultures).
<name> <use value="official" /> <family value="Chalmers" /> <given value="Peter" /> <given value="James" /> </name> <name> <use value="usual" /> <given value="Jim" /> </name><name> <use value="official" /> <family value="Chalmers" /> <given value="Peter" /> <given value="James" /> </name> <name> <use value="usual" /> <given value="Jim" /> </name>
"name" : [{
"use" : "official",
"family" : "Chalmers",
"given" : ["Peter", "James"]
}, {
"use" : "usual",
"given" : ["Jim"]
}]
This same pattern is often encountered with immigrants, who retain their real name for official use, but adopt a localized name for everyday use:
<name> <use value="official" /> <family value="Sczypinski" /> <given value="Piotr" /> <given value="Andre" /> </name> <name> <use value="usual" /> <family value="Skipper" /> <given value="Jim" /> </name><name> <use value="official" /> <family value="Sczypinski" /> <given value="Piotr" /> <given value="Andre" /> </name> <name> <use value="usual" /> <family value="Skipper" /> <given value="Jim" /> </name>
"name" : [{
"use" : "official",
"family" : "Sczypinski",
"given" : ["Piotr", "Andre"]
}, {
"use" : "usual",
"family" : "Skipper",
"given" : ["Jim"]
}]
Some people may also have a nickname that needs to be recorded:
<name> <use value="official" /> <family value="Brown" /> <given value="Steven" /> </name> <name> <use value="nickname" /> <given value="Junior" /> </name><name> <use value="official" /> <family value="Brown" /> <given value="Steven" /> </name> <name> <use value="nickname" /> <given value="Junior" /> </name>
"name" : [{
"use" : "official",
"family" : "Brown",
"given" : ["Steven"]
}, {
"use" : "nickname",
"given" : ["Junior"]
}]
Note
that
there
is
some
ambiguity
in
real
life
as
to
whether
a
non-official
name
is
the
patient's
usual
name,
or
whether
it's
their
nickname
.
In
principle,
nick
names
are
used
occasionally
and
informally,
whereas
the
usual
name
is
used
consistently,
and
in
formal
contexts.
However,
there
is
no
formal
criteria
for
the
differentiating
these
usages,
and
even
within
a
culture,
people
may
vary
in
their
cases.
Karen van Hentenryck is of Dutch origin, and the "van" is a voorvoegsel.
<name> <use value="official" /> <family value="van Hentenryck" > <extension url="http://hl7.org/fhir/StructureDefinition/humanname-own-prefix" > <valueString value="van" /> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/humanname-own-name"> <valueString value="Hentenryck" /> </extension> </family> <given value="Karen" /> </name><name> <use value="official"/> <family value="van Hentenryck"> <extension url="http://hl7.org/fhir/StructureDefinition/humanname-own-prefix"> <valueString value="van"/> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/humanname-own-name"> <valueString value="Hentenryck"/> </extension> </family> <given value="Karen"/> </name>
"name" : {
"use" : "official",
"family" : "van Hentenryck",
"_family" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/humanname-own-prefix",
"valueString" : "van"
}, {
"url" : "http://hl7.org/fhir/StructureDefinition/humanname-own-name",
"valueString" : "Hentenryck"
}]
},
"given" : ["Karen"]
}
See the Extensibility Example for more information about the use of extensions.
Complex example from Germany: Dr.phil. Regina Johanna Maria von Hochheim-Weilenfels, NCFSA. This example shows extensive use of multiple given names, prefixes, suffixes, for academic degrees, nobility titles, and professional designations.
<name> <use value="official" /> <family value="von Hochheim-Weilenfels"> <extension url="http://hl7.org/fhir/StructureDefinition/humanname-own-prefix" > <valueString value="von" /> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/humanname-own-name"> <valueString value="Hochheim-Weilenfels" /> </extension> </family> <given value="Regina" /> <given value="Johanna" /> <given value="Maria" /> <prefix value="Dr. phil."> <extension url="http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier" > <valueCode value="AC" /> </extension> </prefix> <suffix value="NCFSA" /> </name> <name> <use value="maiden" /> <family value="Hochheim" /> </name><name> <use value="official"/> <family value="von Hochheim-Weilenfels"> <extension url="http://hl7.org/fhir/StructureDefinition/humanname-own-prefix"> <valueString value="von"/> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/humanname-own-name"> <valueString value="Hochheim-Weilenfels" /> </extension> </family> <given value="Regina"/> <given value="Johanna"/> <given value="Maria"/> <prefix value="Dr. phil."> <extension url="http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier"> <valueCode value="AC"/> </extension> </prefix> <suffix value="NCFSA"/> </name> <name> <use value="maiden"/> <family value="Hochheim"/> </name>
"name" : [{
"use" : "official",
"family" : "von Hochheim-Weilenfels",
"_family" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/humanname-own-prefix",
"valueString" : "von"
}, {
"url" : "http://hl7.org/fhir/StructureDefinition/humanname-own-name",
"valueString" : "Hochheim-Weilenfels"
}]
},
"given" : ["Regina", "Johanna", "Maria"],
"prefix" : ["Dr. phil."],
"_prefix" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier",
"valueCode" : "AC"
}]
}],
"suffix" : ["NCFSA"]
}, {
"use" : "maiden",
"family" : "Hochheim"
}]
This example makes use of the ISO 21090 extensions to carry the rarely used ISO 21090 qualifier attribute "AC".
Japanese example in the three forms: ideographic (Kanji), syllabic (Hiragana) and alphabetic (Romaji).
<name> <extension url="http://hl7.org/fhir/StructureDefinition/iso21090-EN-representation"> <valueCode value="IDE" /> </extension> <family value="木村" /> <given value="通男" /><name> <extension url="http://hl7.org/fhir/StructureDefinition/iso21090-EN-representation"> <valueCode value="IDE"/> </extension> <family value="木村" /> <given value="通男" /> </name> <name> <extension url="http://hl7.org/fhir/StructureDefinition/iso21090-EN-representation"> <valueCode value="SYL"/> </extension> <family value="きむら" /> <given value="みちお" /> </name><name> <extension url="http://hl7.org/fhir/StructureDefinition/iso21090-EN-representation"> <valueCode value="SYL" /> </extension> <family value="きむら" /> <given value="みちお" /> </name> <name> <extension url="http://hl7.org/fhir/StructureDefinition/iso21090-EN-representation"> <valueCode value="ABC" /> </extension> <family value="KIMURA" /> <given value="MICHIO" /> </name><name> <extension url="http://hl7.org/fhir/StructureDefinition/iso21090-EN-representation"> <valueCode value="ABC"/> </extension> <family value="KIMURA" /> <given value="MICHIO" /> </name>
"name" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/iso21090-EN-representation",
"valueCode" : "IDE"
}],
"family" : "木村",
"given" : ["通男"]
}, {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/iso21090-EN-representation",
"valueCode" : "SYL"
}],
"family" : "きむら",
"given" : ["みちお"]
}, {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/iso21090-EN-representation",
"valueCode" : "ABC"
}],
"family" : "KIMURA",
"given" : ["MICHIO"]
}]
The three forms may be differentiated by the character subset each contains, but some systems require the differentiation to be made manually, which can be done using the ED representation extension.
Russian example in the two forms: Cyrillic and Latin:
<name> <family value="ЕМЕЛИН" /> <given value="ИВАН" /> <given value="ВЛАДИМИРОВИЧ" /> </name> <name> <family value="EMELIN" /> <given value="IVAN" /> <given value="VLADIMIROVICH" /> </name><name> <family value="ЕМЕЛИН" /> <given value="ИВАН" /> <given value="ВЛАДИМИРОВИЧ" /> </name> <name> <family value="EMELIN" /> <given value="IVAN" /> <given value="VLADIMIROVICH" /> </name>
"name" : [{
"family" : "ЕМЕЛИН",
"given" : ["ИВАН", "ВЛАДИМИРОВИЧ"]
}, {
"family" : "EMELIN",
"given" : ["IVAN", "VLADIMIROVICH"]
}]
In Russian usage, these names are known as the domestic and foreign names respectively. The two forms are differentiated by the character subset each contains.
Scandinavian example: Erikson is the family name. Jan Erik are the given names, and Östlund the family name of the mother, which is taken as a Mellannamn.
<name> <use value="official" /> <family value="Erikson" /> <given value="Jan" /> <given value="Erik" /> <given value="Östlund"> <extension url="http://hl7.org/fhir/StructureDefinitioniso-20190#name-qualifier" > <valueCoding> <code value="MID" /> <system value="http://terminology.hl7.org/CodeSystem/v3-EntityNamePartQualifier2" /> </valueCoding> </extension> </given> </name><name> <use value="official" /> <family value="Erikson" /> <given value="Jan" /> <given value="Erik" /> <given value="Östlund"> <extension url="http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier" > <valueCoding> <code value="MID" /> <system value="http://terminology.hl7.org/CodeSystem/v3-EntityNamePartQualifierR2" /> </valueCoding> </extension> </given> </name>
"name" : [{
"use" : "official",
"family" : "Erikson",
"given" : ["Jan", "Erik", "Östlund"],
"_given" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier",
"valueCoding" : {
"code" : "MID",
"system" : "http://terminology.hl7.org/CodeSystem/v3-EntityNamePartQualifierR2"
}
}]
}]
}]
This example makes use of the ISO 21090 extension to carry the culture specific ISO 21090 qualifier attribute "MID" for the Mellannamn.
Then Jan Erikson has a daughter, Karin, with his wife Margrete Hansen. The first communication of the new born name is "Margrete Jente" (Margrete's Girl) and the mother's family name, not the given name (Karin). The father's Family name is not used at all. This is a known temporary name assigned directly after the birth of the child.
<name> <use value="temp" /> <!-- use could be OR+OLD, depends how record keeping is done --> <family value="Hansen" /> <given value="Margrete Jente" /> </name><name> <use value="temp" /> <!-- use could be OR+OLD, depends how record keeping is done --> <family value="Hansen" /> <given value="Margrete Jente" /> </name>
"name" : {
"use" : "temp",
// use could be OR+OLD, depends how record keeping is done
"family" : "Hansen",
"given" : ["Margrete Jente"]
}
The baby's name is subsequently changed to the fathers' family name, and to use the mother's name as mellomnamn.
<name> <use value="official" /> <family value="Erikson" /> <given value="Karin" /> <given value="Hansen"> <extension url="http://hl7.org/fhir/StructureDefinitioniso-20190#name-qualifier" > <valueCoding> <code value="MID" /> <system value="http://terminology.hl7.org/CodeSystem/v3-EntityNamePartQualifier2" /> </valueCoding> </extension> </given> </name><name> <use value="official"/> <family value="Erikson"/> <given value="Karin"/> <given value="Hansen"> <extension url="http://hl7.org/fhir/StructureDefinitioniso-20190#name-qualifier"> <valueCoding> <code value="MID"/> <system value="http://terminology.hl7.org/CodeSystem/v3-EntityNamePartQualifier2"/> </valueCoding> </extension> </given> </name>
"name" : {
"use" : "official",
"family" : "Erikson",
"given" : ["Karin", "Hansen"],
"_given" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinitioniso-20190#name-qualifier",
"valueCoding" : {
"code" : "MID",
"system" : "http://terminology.hl7.org/CodeSystem/v3-EntityNamePartQualifier2"
}
}]
}]
}
Later,
Karin
gets
married
to
Per
Berg,
and
decides
to
adopt
Berg
as
her
family
name,
and
also
decides
to
use
Erikson
as
the
mellom
navn.
(Note:
Karin
could
have
chosen
to
use
another
mellom
navn,
e.g.
e.g.,
the
family
name
of
her
mother,
her
father
or
other
family
names
as
specified
by
naming
laws
of
the
country
in
question).
<name> <use value="old" /> <family value="Erikson" /> <given value="Karin" /> <given value="Hansen"> <extension url="http://hl7.org/fhir/StructureDefinitioniso-20190#name-qualifier" > <valueCoding> <code value="MID" /> <system value="http://terminology.hl7.org/CodeSystem/v3-EntityNamePartQualifier2" /> </valueCoding> </extension> </given> </name> <name> <use value="official" /> <family value="Berg" /> <given value="Karin" /> <given value="Erikson"> <extension url="http://hl7.org/fhir/StructureDefinitioniso-20190#name-qualifier" > <valueCoding> <code value="MID" /> <system value="http://terminology.hl7.org/CodeSystem/v3-EntityNamePartQualifier2" /> </valueCoding> </extension> </given> </name> <name> <use value="usual" /> <family value="Berg" /> <given value="Karin" /> </name><name> <use value="old"/> <family value="Erikson"/> <given value="Karin"/> <given value="Hansen"> <extension url="http://hl7.org/fhir/StructureDefinitioniso-20190#name-qualifier"> <valueCoding> <code value="MID"/> <system value="http://terminology.hl7.org/CodeSystem/v3-EntityNamePartQualifier2"/> </valueCoding> </extension> </given> </name> <name> <use value="official"/> <family value="Berg"/> <given value="Karin"/> <given value="Erikson"> <extension url="http://hl7.org/fhir/StructureDefinitioniso-20190#name-qualifier"> <valueCoding> <code value="MID"/> <system value="http://terminology.hl7.org/CodeSystem/v3-EntityNamePartQualifier2"/> </valueCoding> </extension> </given> </name> <name> <use value="usual"/> <family value="Berg"/> <given value="Karin"/> </name>
"name" : [{
"use" : "old",
"family" : "Erikson",
"given" : ["Karin", "Hansen"],
"_given" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinitioniso-20190#name-qualifier",
"valueCoding" : {
"code" : "MID",
"system" : "http://terminology.hl7.org/CodeSystem/v3-EntityNamePartQualifier2"
}
}]
}]
}, {
"use" : "official",
"family" : "Berg",
"given" : ["Karin", "Erikson"],
"_given" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinitioniso-20190#name-qualifier",
"valueCoding" : {
"code" : "MID",
"system" : "http://terminology.hl7.org/CodeSystem/v3-EntityNamePartQualifier2"
}
}]
}]
}, {
"use" : "usual",
"family" : "Berg",
"given" : ["Karin"]
}]
These
examples
are
taken
from
the
W3C
International
Examples
,
which
should
be
consulted
for
further
information.
A patronymic is "The part of a name that links to the genealogy":
<name> <text value="Björk Guðmundsdóttir"/> <family value="Guðmundsdóttir"/> <given value="Björk"/> </name><name> <text value="Björk Guðmundsdóttir"/> <family value="Guðmundsdóttir"/> <given value="Björk"/> </name>
"name" : {
"text" : "Björk Guðmundsdóttir",
"family" : "Guðmundsdóttir",
"given" : ["Björk"]
}
A patronymic with a "son/daughter of" appellation:
<name> <text value="Isa bin Osman"/> <family value="bin Osman"/> <given value="Isa"/> </name><name> <text value="Isa bin Osman"/> <family value="bin Osman"/> <given value="Isa"/> </name>
"name" : {
"text" : "Isa bin Osman",
"family" : "bin Osman",
"given" : ["Isa"]
}
A Chinese name with a generational name:
<name> <text value="毛泽东"/> <!-- left to right --> <family value="毛"/> <given value="泽东"/> </name> <name> <text value="Mao Ze Dong"/> <!-- left to right --> <family value="Mao"/> <given value="Ze Dong"/> </name><name> <text value="毛泽东"/> <!-- left to right --> <family value="毛"/> <given value="泽东"/> </name> <name> <text value="Mao Ze Dong"/> <!-- left to right --> <family value="Mao"/> <given value="Ze Dong"/> </name>
"name" : [{
"text" : "毛泽东", // left to right
"family" : "毛",
"given" : ["泽东"]
}, {
"text" : "Mao Ze Dong", // left to right
"family" : "Mao",
"given" : ["Ze Dong"]
}]
Note
that
many
systems
in
China
do
not
store
family
and
given
names
separately,
and
just
use
text
.
Additional Western name (see also example above):
<name> <use value="official" /> <family value="Yao" /> <given value="Ming" /> </name> <name> <use value="usual" /> <given value="Fred" /> </name><name> <use value="official" /> <family value="Yao" /> <given value="Ming" /> </name> <name> <use value="usual" /> <given value="Fred" /> </name>
"name" : [{
"use" : "official",
"family" : "Yao",
"given" : ["Ming"]
}, {
"use" : "usual",
"given" : ["Fred"]
}]
Composite Family name:
<name> <family value="Carreño Quiñones" > <extension url="http://hl7.org/fhir/StructureDefinition/humanname-fathers"> <valueString value="Carreño" /> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/humanname-mothers"> <valueString value="Quiñones" /> </extension> </family> <given value="María-Jose" /> </name><name> <family value="Carreño Quiñones" > <extension url="http://hl7.org/fhir/StructureDefinition/humanname-fathers"> <valueString value="Carreño"/> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/humanname-mothers"> <valueString value="Quiñones"/> </extension> </family> <given value="María-Jose" /> </name>
"name" : {
"family" : "Carreño Quiñones",
"_family" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/humanname-fathers",
"valueString" : "Carreño"
}, {
"url" : "http://hl7.org/fhir/StructureDefinition/humanname-mothers",
"valueString" : "Quiñones"
}]
},
"given" : ["María-Jose"]
}
Note that it is optional whether to break down the family name to mother's and father's parts, and not always of value, as in this Brazilian Example:
<name> <family value="Santos Tavares Melo Silva" /> <given value="José" /> <given value="Eduardo" /> </name><name> <family value="Santos Tavares Melo Silva" /> <given value="José" /> <given value="Eduardo" /> </name>
"name" : {
"family" : "Santos Tavares Melo Silva",
"given" : ["José", "Eduardo"]
}
Note that this naming pattern can become quite extreme ("Pedro de Alcântara João Carlos Leopoldo Salvador Bibiano Francisco Xavier de Paula Leocádio Miguel Gabriel Rafael Gonzaga"). A more practical example is
<name> <family value="Costa Teixeira" > <extension url="http://hl7.org/fhir/StructureDefinition/humanname-fathers"> <valueString value="Costa" /> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/humanname-mothers"> <valueString value="Teixeira" /> </extension> </family> <given value="Manuel" /> </name><name> <family value="Costa Teixeira" > <extension url="http://hl7.org/fhir/StructureDefinition/humanname-fathers"> <valueString value="Costa"/> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/humanname-mothers"> <valueString value="Teixeira"/> </extension> </family> <given value="Manuel" /> </name>
"name" : {
"family" : "Costa Teixeira",
"_family" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/humanname-fathers",
"valueString" : "Costa"
}, {
"url" : "http://hl7.org/fhir/StructureDefinition/humanname-mothers",
"valueString" : "Teixeira"
}]
},
"given" : ["Manuel"]
}
After marriage, this may change to
<name> <family value="Costa Teixeira Sanches" > <extension url="http://hl7.org/fhir/StructureDefinition/humanname-fathers"> <valueString value="Costa" /> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/humanname-mothers"> <valueString value="Teixeira" /> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/humanname-partners-name"> <valueString value="Sanches" /> </extension> </family> <given value="Manuel" /> </name><name> <family value="Costa Teixeira Sanches" > <extension url="http://hl7.org/fhir/StructureDefinition/humanname-fathers"> <valueString value="Costa"/> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/humanname-mothers"> <valueString value="Teixeira"/> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/humanname-partners-name"> <valueString value="Sanches"/> </extension> </family> <given value="Manuel" /> </name>
"name" : {
"family" : "Costa Teixeira Sanches",
"_family" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/humanname-fathers",
"valueString" : "Costa"
}, {
"url" : "http://hl7.org/fhir/StructureDefinition/humanname-mothers",
"valueString" : "Teixeira"
}, {
"url" : "http://hl7.org/fhir/StructureDefinition/humanname-partners-name",
"valueString" : "Sanches"
}]
},
"given" : ["Manuel"]
}
Russian Examples (using Cyrillic):
<name> <family value="Ельцин" /> <given value="Борис" /> <given value="Николаевич" /> </name><name> <family value="Ельцин" /> <given value="Борис" /> <given value="Николаевич" /> </name><name> <family value="Ельцина" /> <given value="Наина" /> <given value="Иосифовна" /> </name><name> <family value="Ельцина" /> <given value="Наина" /> <given value="Иосифовна" /> </name>
"name" : [{
"family" : "Ельцин",
"given" : ["Борис", "Николаевич"]
}, {
"family" : "Ельцина",
"given" : ["Наина", "Иосифовна"]
}]
Example with Initial:
<name> <family value="Public" /> <given value="John" /> <given value="Q." /> </name><name> <family value="Public" /> <given value="John" /> <given value="Q." /> </name>
"name" : {
"family" : "Public",
"given" : ["John", "Q."]
}
Other Examples:
<name> <text value="Velikkakathu Sankaran Achuthanandan"/> <family value="Velikkakathu" /> <given value="Sankaran" /> <given value="Achuthanandan" /> </name> <name> <text value="Kogaddu Birappa Timappa Nair"/> <family value="Nair" /> <given value="Birappa" /> <given value="Timappa" /> <prefix value="Kogaddu" /> </name> <name> <text value="Aditya Pratap Singh Chauhan"/> <family value="Singh" /> <given value="Aditya" /> <given value="Pratap" /> <suffix value="Chauhan" /> </name> <name> <text value="Madurai Mani Iyer"/> <given value="Mani" /> <prefix value="Madurai" /> <suffix value="Iyer" /> </name> <name> <text value="Abu Karim Muhammad al-Jamil ibn Nidal ibn Abdulaziz al-Filistini"/> <family value="ibn Nidal ibn Abdulaziz" /> <given value="Muhammad" /> <given value="al-Jamil" /> <prefix value="Abu Karim" /> <suffix value="al-Filistini" /> </name><name> <text value="Velikkakathu Sankaran Achuthanandan"/> <family value="Velikkakathu" /> <given value="Sankaran" /> <given value="Achuthanandan" /> </name> <name> <text value="Kogaddu Birappa Timappa Nair"/> <family value="Nair" /> <given value="Birappa" /> <given value="Timappa" /> <prefix value="Kogaddu" /> </name> <name> <text value="Aditya Pratap Singh Chauhan"/> <family value="Singh" /> <given value="Aditya" /> <given value="Pratap" /> <suffix value="Chauhan" /> </name> <name> <text value="Madurai Mani Iyer"/> <given value="Mani" /> <prefix value="Madurai" /> <suffix value="Iyer" /> </name> <name> <text value="Abu Karim Muhammad al-Jamil ibn Nidal ibn Abdulaziz al-Filistini"/> <family value="ibn Nidal ibn Abdulaziz" /> <given value="Muhammad" /> <given value="al-Jamil" /> <prefix value="Abu Karim" /> <suffix value="al-Filistini" /> </name>
"name" : [{
"text" : "Velikkakathu Sankaran Achuthanandan",
"family" : "Velikkakathu",
"given" : ["Sankaran", "Achuthanandan"]
}, {
"text" : "Kogaddu Birappa Timappa Nair",
"family" : "Nair",
"given" : ["Birappa", "Timappa"],
"prefix" : ["Kogaddu"]
}, {
"text" : "Aditya Pratap Singh Chauhan",
"family" : "Singh",
"given" : ["Aditya", "Pratap"],
"suffix" : ["Chauhan"]
}, {
"text" : "Madurai Mani Iyer",
"given" : ["Mani"],
"prefix" : ["Madurai"],
"suffix" : ["Iyer"]
}, {
"text" : "Abu Karim Muhammad al-Jamil ibn Nidal ibn Abdulaziz al-Filistini",
"family" : "ibn Nidal ibn Abdulaziz",
"given" : ["Muhammad", "al-Jamil"],
"prefix" : ["Abu Karim"],
"suffix" : ["al-Filistini"]
}]
Todo:
need
to
discuss
this
with
Indian
/
Arabic
implementers
.
Note
that
collecting
and
storing
the
text
element
makes
the
primary
purpose
of
the
structured
parts
for
index/searching,
and
fidelity
of
the
name
parts
is
not
critical.
See
also
Base
Definition
,
Detailed
Descriptions
,
Mappings
,
Profiles
&
Extensions
and
R2
Conversions
.
Extensions
Note about these examples: the most important element in an address is the 'text' element - this defines what is printed on the envelope, the actual postal address. The other data elements are provided to support either data analysis based on a patient's address, or for the many systems that exchange fully structured addresses specific to a particular culture. For this reason, these examples focus on the structured data elements of the address.
Example
HL7 office's address.
<address><use value="work" /> <text value="1050 W Wishard Blvd<use value="work" /> <text value="1050 W Wishard Blvd RG 5th floor Indianapolis, IN 46240" /><line value="1050 W Wishard Blvd" /> <line value="RG 5th floor" /> <city value="Indianapolis" /> <state value="IN" /> <postalCode value="46240" /><line value="1050 W Wishard Blvd" /> <line value="RG 5th floor" /> <city value="Indianapolis" /> <state value="IN" /> <postalCode value="46240" /> </address>
"address" : {
"use" : "work",
"text" : "1050 W Wishard Blvd
RG, 5th floor
Indianapolis, IN 46240",
"line" : ["1050 W Wishard Blvd", "RG 5th floor"],
"city" : "Indianapolis",
"state" : "IN",
"postalCode" : "46240"
}
HL7 office's address with the codedString extension present
<address>
<use value="work" />
<text value="1050 W Wishard Blvd
RG
5th floor
Indianapolis, IN 46240" />
<line value="1050 W Wishard Blvd" />
<line value="RG 5th floor" />
<city value="Indianapolis" />
<state value="IN">
<extension url="http://hl7.org/fhir/StructureDefinition/iso21090-codedString">
<valueCoding>
<system value="urn:iso:std:iso:3166"/>
<code value="US"/>
</valueCoding>
</extension>
</state>
<postalCode value="46240" />
<country value="United States">
<extension url="http://hl7.org/fhir/StructureDefinition/iso21090-codedString">
<valueCoding>
<system value="urn:iso:std:iso:3166"/>
<code value="US"/>
</valueCoding>
</extension>
</country>
</address>
"address" : {
"use" : "work",
"text" : "1050 W Wishard Blvd
RG,
5th floor
Indianapolis, IN 46240",
"line" : ["1050 W Wishard Blvd", "RG 5th floor"],
"city" : "Indianapolis",
"state" : "IN",
"_state" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/iso21090-codedString",
"valueCoding" : {
"system" : "urn:iso:std:iso:3166",
"code" : "IN"
}
}]
},
"postalCode" : "46240",
"country" : "United States",
"_country" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/iso21090-codedString",
"valueCoding" :{
"system" : "urn:iso:std:iso:3166",
"code" : "IN"
}
}]
}
}
A UK example address, with the county 'HUDDERSFIELD'.
<address>
<text value="1 Back Lane Holmfirth HUDDERSFIELD HD7 1HQ"/>
<line value="1 Back Lane"/>
<city value="Holmfirth"/>
<district value="HUDDERSFIELD"/>
<postalCode value="HD7 1HQ"/>
</address>
"address" : {
"text" : "1 Back Lane Holmfirth HUDDERSFIELD HD7 1HQ",
"line" : ["1 Back Lane"],
"city" : "Holmfirth",
"district" : "HUDDERSFIELD",
"postalCode" : "HD7 1HQ"
}
A
temporary
postal
address
-
i.e.
i.e.,
an
address
that
it
doesn't
make
sense
to
try
and
visit.
<address>
<use value="temp"/>
<type value="postal"/>
<line value="PO Box 31445"/>
<city value="Erewhon"/>
<postalCode value="0001"/>
</address>
"address" : {
"use" : "temp" ,
"type" : "postal",
"line" : ["PO Box 31445"],
"city" : "Erewhon",
"postalCode" : "0001"
}
An example of an address with the codedString extension present
<address>
<use value="work" />
<text value="1050 W Wishard Blvd
RG
5th floor
Indianapolis, IN 46240" />
<line value="1050 W Wishard Blvd" />
<line value="RG 5th floor" />
<city value="Indianapolis" />
<state value="IN" />
<postalCode value="46240" />
</address>
"address" : {
"use" : "work",
"text" : "1050 W Wishard Blvd
RG,
5th floor
Indianapolis, IN 46240",
"line" : ["1050 W Wishard Blvd", "RG 5th floor"],
"city" : "Indianapolis",
"state" : "IN",
"postalCode" : "46240"
}
The
next
set
of
examples
are
taken
from
the
official
international
postal
union
examples.
| Rue Lougoraïa 12, app. 10 | thoroughfare type, name and number, apartment |
| Korolevo | locality |
| 223016 NOVY DVOR | postcode + post office name |
| Minsk | District name of district |
| Minsk | Region name of region |
| BELARUS | Country |
<address>
<line value="Rue Lougoraïa 12, app. 10"/>
<city value="Korolevo"/>
<district value="Minsk"/>
<state value="Minsk" />
<country value="BELARUS" />
</address>
"address" : {
"line" : ["Rue Lougoraïa 12, app. 10"],
"city" : "Korolevo",
"district" : "Minsk",
"state" : "Minsk",
"country" : "BELARUS"
}
| Protea Apt 12 | apartment number |
| 22 Ally Hassan Mwinyi | premise + street |
| 14111 MSASANI | postcode + locality |
| DAR ES SALAM | province |
| TANZANIA | country |
<address>
<line value="Protea Apt 12"/>
<line value="22 Ally Hassan Mwinyi"/>
<city value="MSASANI"/>
<state value="DAR ES SALAM" />
<postalCode value="14111"/>
<country value="TANZANIA" />
</address>
"address" : {
"line" : ["Protea Apt 12", "22 Ally Hassan Mwinyi"],
"city" : "MSASANI",
"state" : "DAR ES SALAM",
"postalCode" : "14111",
"country" : "TANZANIA"
}
| 15 Shiri | premise + sub-locality 2 |
| Kimashuku Village | sub-locality |
| 25204 MACHAME KUSINI | postcode + locality |
| HAI | sub-province |
| KILIMANJARO | province |
| TANZANIA | country |
<address>
<extension url="http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-precinct">
<valueCode value="Kimashuku Village"/>
</extension>
<line value="15 Shiri"/>
<city value="MACHAME KUSINI"/>
<district value="HAI"/>
<state value="KILIMANJARO" />
<postalCode value="25204"/>
<country value="TANZANIA" />
</address>
"address" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-precinct",
"valueCode" : "Kimashuku Village"
}],
"line" : ["15 Shiri"],
"city" : "MACHAME KUSINI",
"district" : "HAI",
"state" : "KILIMANJARO",
"postalCode" : "25204",
"country" : "TANZANIA"
}
| 705-1104 | building number + door |
| 56, Dalgubeol-daero 323beon-gil, Suseong-gu | street |
| Daegu | city |
| Rep. OF KOREA | country |
| 706-907 | postcode |
<address>
<line value="705-1104"/>
<line value="56, Dalgubeol-daero 323beon-gil, Suseong-gu"/>
<city value="Daegu"/>
<country value="Rep. OF KOREA" />
<country value="Rep. OF KOREA"/>
<postalCode value="706-907"/>
</address>
"address" : {
"line" : ["705-1104", "56, Dalgubeol-daero 323beon-gil, Suseong-gu"],
"city" : "Daegu",
"country" : "Rep. OF KOREA",
"postalCode" : "706-907"
}
| 3F | building floor |
| 42, Toegye-ro 77beon-gil | street |
| Chuncheon-si | city |
| Gangwon-do | province |
| Rep. OF KOREA | country |
| 200-066 | postcode |
<address>
<line value="3F"/>
<line value="42, Toegye-ro 77beon-gil"/>
<city value="Chuncheon-si"/>
<state value="Gangwon-do" />
<country value="Rep. OF KOREA" />
<state value="Gangwon-do"/>
<country value="Rep. OF KOREA"/>
<postalCode value="200-066"/>
</address>
"address" : {
"line" : ["3F", "42, Toegye-ro 77beon-gil"],
"city" : "Chuncheon-si",
"state" : "Gangwon-do",
"country" : "Rep. OF KOREA",
"postalCode" : "200-066"
}
| Ga-B101 | building number + door |
| 136, Sesil-ro | street |
| Busan | city |
| Rep. OF KOREA | country |
| 612-837 | postcode |
<address>
<line value="Ga-B101"/>
<line value="136, Sesil-ro"/>
<city value="Busan"/>
<country value="Rep. OF KOREA" />
<country value="Rep. OF KOREA"/>
<postalCode value="612-837"/>
</address>
"address" : {
"line" : ["Ga-B101", "136, Sesil-ro"],
"city" : "Busan",
"country" : "Rep. OF KOREA",
"postalCode" : "612-837"
}
Some of the extensions that provide further analysis of the parts of the address require duplication of address content.
<address>
<line value="Care of: Dr Smith">
<extension url="http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-careOf">
<valueString value="Dr. Smith"/>
</extension>
</line>
<line value="123 Somewhere Street NW">
<extension url="http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber">
<valueString value="123"/>
</extension>
<extension url="http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetNameBase">
<valueString value="Somewhere"/>
</extension>
<extension url="http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetNameBase">
<valueString value="Street"/>
</extension>
<extension url="http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetNameBase">
<valueString value="NW"/>
</extension>
</line>
</address>
"address" : {
"line" : ["Care of: Dr Smith", "123 Somewhere Street NW"],
"_line" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-careOf",
"valueString" : "Dr. Smith"
},{
"url" : "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-houseNumber",
"valueString" : "123"
}, {
"url" : "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetNameBase",
"valueString" : "Somewhere"
}, {
"url" : "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetNameBase",
"valueString" : "Street"
}, {
"url" : "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-streetNameBase",
"valueString" : "NW"
}]
}]
}
In some case, this may mean that the extension repeats the full value of the address line. However, this is not a given for all lines of the specified type in all jurisdictions, and thus the convention of repeating the 'part' of the line that applies in the extension, even if it might be the whole line.
See
also
Base
Definition
,
Detailed
Descriptions
,
Mappings
,
Profiles
&
Extensions
and
R2
Conversions
.
Extensions
Example
Home phone number:
In
ISO
21090,
CDA
and
other
HL7
v3
specifications,
the
TEL
data
type
datatype
requires
that
the
telephone
number
be
represented
as
a
formal
URI
in
RFC
3166
syntax.
Many
CDA
documents
violate
this
rule,
since
the
telephone
numbers
are
not
collected
from
the
user
in
conformance
with
the
underlying
rules
(particularly
around
extensions,
notes
about
use,
etc.),
so
the
base
FHIR
type
does
not
require
the
phone
number
to
be
conformant.
An
ISO
21090
extension
can
be
used
to
convey
this
if
desired:
Example
Formally correct URI:
<telecom>
<extension url="http://hl7.org/fhir/StructureDefinition/iso21090-TEL-address" >
<valueUri value="tel:+15556755745" />
</extension>
<system value="phone" />
<value value="(555) 675 5745" />
<use value="home" />
</telecom>
"telecom" : {
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/iso21090-TEL-address",
"valueUri" : "tel:+15556755745"
}],
"system" : "phone",
"value" : "(555) 675 5745",
"use" : "home"
}
See
also
Base
Definition
,
Detailed
Descriptions
,
Mappings
,
Profiles
&
Extensions
and
R2
Conversions
.
Extensions
Example
A series of appointments for radiotherapy:
<schedule>
<event value="2012-01-07T09:00:00+10:00" />
<event value="2012-01-14T09:00:00+10:00" />
<event value="2012-01-22T11:00:00+10:00" />
</schedule>
"schedule" : {
"event" : ["2012-01-07T09:00:00+10:00", "2012-01-14T09:00:00+10:00", "2012-01-22T11:00:00+10:00"]
}
BID (twice a day) (no start or end specified):
<schedule>
<repeat>
<frequency value="2" />
<period value="1" />
<periodUnit value="d" />
</repeat>
</schedule>
"schedule" : {
"repeat" : {
"frequency" : "2",
"period" : "1",
"periodUnit" : "d"
}
}
1/2 an hour before breakfast for 10 days from 23-Dec 2011:
<schedule>
<repeat>
<boundsPeriod>
<start value="2011-12-23" />
<end value="2012-01-02" />
</boundsPeriod>
<when value="ACM" />
<offset value="30" />
</repeat>
</schedule>
"schedule" : {
"repeat" : {
"boundsPeriod" : {
"start" : "2011-12-23",
"end" : "2012-01-02"
},
"when" : ["ACM"],
"offset" : "30"
}
}
Note that the end date is inclusive like the end date of a Period.
TID, for 14 days:
<schedule>
<repeat>
<boundsDuration>
<value value="14" />
<unit value="d" />
<system value="http://unitsofmeasure.org" />
<code value="d" />
</boundsDuration>
<frequency value="3" />
<period value="1" />
<periodUnit value="d" />
</repeat>
</schedule>
"schedule" : {
"repeat" : {
"boundsDuration" : {
"value" : "14",
"unit" : "d",
"system" : "http://unitsofmeasure.org",
"code" : "d"
},
"frequency" : "3",
"period" : "1",
"periodUnit" : "d"
}
}
BID, start on 7/1/2015 at 1:00 PM:
<schedule>
<repeat>
<boundsPeriod>
<start value="2015-07-01T13:00:00" />
</boundsPeriod>
<frequency value="2" />
<period value="1" />
<periodUnit value="d" />
</repeat>
</schedule>
"schedule" : {
"repeat" : {
"boundsPeriod" : {
"start" : "2015-07-01T13:00:00"
},
"frequency" : "2",
"period" : "1",
"periodUnit" : "d"
}
}
Take just once, with no specified time
See also Base Definition , Detailed Descriptions , Mappings , Profiles and Extensions
Example
Start a treatment the day after surgery:
<contextCode>
<coding>
<system value="http://snomed.info/sct"/>
<code value="38102005"/>
<display value="Removal of gallbladder"/>
</coding>
</contextCode>
<offsetDuration>
<value value="1"/>
<system value="http://unitsofmeasure.org"/>
<code value="d"/>
</offsetDuration>
{
"contextCode" : {
"coding" : [{
"system" : "http://snomed.info/sct",
"code" : "38102005",
"display" : "Removal of gallbladder"
}]
},
"offsetDuration" : {
"value" : 1,
"system" : "http://unitsofmeasure.org",
"code" : "d"
}
}
See
also
Base
Definition
,
Detailed
Descriptions
,
Mappings
,
Profiles
&
Extensions
and
R2
Conversions
.
Extensions
Example
<signature><!-- todo --><type> <system value="urn:iso-astm:E1762-95:2013"/> <code value="1.2.840.10065.1.12.1.1"/> <display value="Author's Signature"/> </type> <when value="2022-02-08T10:16:32.000+10:00"/> <who> <reference value="Practitioner/example"/> </who> <targetFormat value="application/fhir+xml"/> <data value="PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiPz4KPEVudmVsb3BlIHhtbG5zPSJ1cm46ZW52ZWxvcGUiPgogIDxTaWduYXR1cmUgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvMDkveG1sZHNpZyMiPgogICAgPFNpZ25lZEluZm8+CiAgICAgIDxDYW5vbmljYWxpemF0aW9uTWV0aG9kIAogICAgICAgICAgIEFsZ29yaXRobT0iaHR0cDovL3d3dy53My5vcmcvVFIvMjAwMS9SRUMteG1sLWMxNG4tCjIwMDEwMzE1I1dpdGhDb21tZW50cyIvPgogICAgICA8U2lnbmF0dXJlTWV0aG9kIEFsZ29yaXRobT0iaHR0cDovL3d3dy53My5vcmcvMjAwMC8wOS8KeG1sZHNpZyNkc2Etc2hhMSIvPgogICAgICA8UmVmZXJlbmNlIFVSST0iIj4KICAgICAgICA8VHJhbnNmb3Jtcz4KICAgICAgICAgIDxUcmFuc2Zvcm0gQWxnb3JpdGhtPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwLzA5Lwp4bWxkc2lnI2VudmVsb3BlZC1zaWduYXR1cmUiLz4KICAgICAgICA8L1RyYW5zZm9ybXM+CiAgICAgICAgPERpZ2VzdE1ldGhvZCBBbGdvcml0aG09Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvMDkvCnhtbGRzaWcjc2hhMSIvPgogICAgICAgIDxEaWdlc3RWYWx1ZT51b29xYldZYTVWQ3FjSkNidXltQktxbTE3dlk9PC9EaWdlc3RWYWx1ZT4KICAgICAgPC9SZWZlcmVuY2U+CiAgICA8L1NpZ25lZEluZm8+CjxTaWduYXR1cmVWYWx1ZT4KS2VkSnVUb2I1Z3R2WXg5cU0zazNnbTdrYkxCd1ZiRVFSbDI2UzJ0bVhqcU5ORDdNUkd0b2V3PT0KICAgIDwvU2lnbmF0dXJlVmFsdWU+CiAgICA8S2V5SW5mbz4KICAgICAgPEtleVZhbHVlPgogICAgICAgIDxEU0FLZXlWYWx1ZT4KICAgICAgICAgIDxQPgovS2FDem80U3lyb203OHozRVE1U2JiQjRzRjdleTgwZXRLSUk4NjRXRjY0QjgxdVJwSDV0OWpRVHhlCkV1MEltYnpSTXF6VkRaa1ZHOXhEN25OMWt1Rnc9PQogICAgICAgICAgPC9QPgogICAgICAgICAgPFE+bGk3ZHpEYWN1bzY3Smc3bXRxRW0yVFJ1T01VPTwvUT4KICAgICAgICAgIDxHPlo0UnhzbnFjOUU3cEdrbkZGSDJ4cWFyeVJQQmFRMDFraHBNZExSUW5HNTQxQXd0eC8KWFBhRjVCcHN5NHBOV01PSENCaU5VME5vZ3BzUVc1UXZubE1wQT09CiAgICAgICAgICA8L0c+CiAgICAgICAgICA8WT5xVjM4SXFyV0pHMFYvCm1aUXZSVmkxT0h3OVpqODRuREM0ak84UDBheGkxZ2I2ZCs0NzV5aE1qU2MvCkJySVZDNThXM3lkYmtLK1JpNE9LYmFSWmxZZVJBPT0KICAgICAgICAgPC9ZPgogICAgICAgIDwvRFNBS2V5VmFsdWU+CiAgICAgIDwvS2V5VmFsdWU+CiAgICA8L0tleUluZm8+CiAgPC9TaWduYXR1cmU+CjwvRW52ZWxvcGU+IA=="/> </signature>
"signature" : {
"type" : [{
"system" : "urn:iso-astm:E1762-95:2013",
"code" : "1.2.840.10065.1.12.1.1",
"display" : "Author's Signature"
}],
"when" : "2022-02-08T10:16:32.000+10:00",
"who" : {
"reference" : "Practitioner/example"
},
"targetFormat" : "application/fhir+xml",
"data" : "PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiPz4KPEVudmVsb3BlIHhtbG5zPSJ1cm46ZW52ZWxvcGUiPgogIDxTaWduYXR1cmUgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvMDkveG1sZHNpZyMiPgogICAgPFNpZ25lZEluZm8+CiAgICAgIDxDYW5vbmljYWxpemF0aW9uTWV0aG9kIAogICAgICAgICAgIEFsZ29yaXRobT0iaHR0cDovL3d3dy53My5vcmcvVFIvMjAwMS9SRUMteG1sLWMxNG4tCjIwMDEwMzE1I1dpdGhDb21tZW50cyIvPgogICAgICA8U2lnbmF0dXJlTWV0aG9kIEFsZ29yaXRobT0iaHR0cDovL3d3dy53My5vcmcvMjAwMC8wOS8KeG1sZHNpZyNkc2Etc2hhMSIvPgogICAgICA8UmVmZXJlbmNlIFVSST0iIj4KICAgICAgICA8VHJhbnNmb3Jtcz4KICAgICAgICAgIDxUcmFuc2Zvcm0gQWxnb3JpdGhtPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwLzA5Lwp4bWxkc2lnI2VudmVsb3BlZC1zaWduYXR1cmUiLz4KICAgICAgICA8L1RyYW5zZm9ybXM+CiAgICAgICAgPERpZ2VzdE1ldGhvZCBBbGdvcml0aG09Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvMDkvCnhtbGRzaWcjc2hhMSIvPgogICAgICAgIDxEaWdlc3RWYWx1ZT51b29xYldZYTVWQ3FjSkNidXltQktxbTE3dlk9PC9EaWdlc3RWYWx1ZT4KICAgICAgPC9SZWZlcmVuY2U+CiAgICA8L1NpZ25lZEluZm8+CjxTaWduYXR1cmVWYWx1ZT4KS2VkSnVUb2I1Z3R2WXg5cU0zazNnbTdrYkxCd1ZiRVFSbDI2UzJ0bVhqcU5ORDdNUkd0b2V3PT0KICAgIDwvU2lnbmF0dXJlVmFsdWU+CiAgICA8S2V5SW5mbz4KICAgICAgPEtleVZhbHVlPgogICAgICAgIDxEU0FLZXlWYWx1ZT4KICAgICAgICAgIDxQPgovS2FDem80U3lyb203OHozRVE1U2JiQjRzRjdleTgwZXRLSUk4NjRXRjY0QjgxdVJwSDV0OWpRVHhlCkV1MEltYnpSTXF6VkRaa1ZHOXhEN25OMWt1Rnc9PQogICAgICAgICAgPC9QPgogICAgICAgICAgPFE+bGk3ZHpEYWN1bzY3Smc3bXRxRW0yVFJ1T01VPTwvUT4KICAgICAgICAgIDxHPlo0UnhzbnFjOUU3cEdrbkZGSDJ4cWFyeVJQQmFRMDFraHBNZExSUW5HNTQxQXd0eC8KWFBhRjVCcHN5NHBOV01PSENCaU5VME5vZ3BzUVc1UXZubE1wQT09CiAgICAgICAgICA8L0c+CiAgICAgICAgICA8WT5xVjM4SXFyV0pHMFYvCm1aUXZSVmkxT0h3OVpqODRuREM0ak84UDBheGkxZ2I2ZCs0NzV5aE1qU2MvCkJySVZDNThXM3lkYmtLK1JpNE9LYmFSWmxZZVJBPT0KICAgICAgICAgPC9ZPgogICAgICAgIDwvRFNBS2V5VmFsdWU+CiAgICAgIDwvS2V5VmFsdWU+CiAgICA8L0tleUluZm8+CiAgPC9TaWduYXR1cmU+CjwvRW52ZWxvcGU+IA=="
}
See
also
Base
Definition
,
Detailed
Descriptions
,
Mappings
,
Profiles
&
Extensions
and
R2
Conversions
.
Extensions
Example
<Annotation><!-- todo --><authorReference> <reference value="Patient/example"/> </authorReference> <time value="2022-02-08T10:18:14.034+10:00"/> <text value="I don't think that this is true, or what I said, and it should be corrected"/> </Annotation>
"Annotation" : {
"authorReference" : {
"reference" : "Patient/example"
},
"time" : "2022-02-08T10:18:14.034+10:00",
"text" : "I don't think that this is true, or what I said, and it should be corrected"
}
FHIR
®©
HL7.org
2011+.
FHIR
Release
4
(Technical
Correction
#1)
(v4.0.1)
R6
hl7.fhir.core#6.0.0-ballot3
generated
on
Fri,
Sun,
Nov
1,
2019
09:37+1100.
QA
Page
9,
2025
02:09+0000.
Links:
Search
|
Version
History
|
Table
of
Contents
|
Credits
Glossary
|
QA
|
Compare
to
R3
R4
|
Compare
to
R5
|
Compare
to
Last
Ballot
|
|
Propose
a
change