This
page
is
part
of
the
FHIR
Specification
(v3.0.2:
STU
3).
The
current
version
which
supercedes
this
version
is
5.0.0
.
For
a
full
list
Continuous
Integration
Build
of
available
versions,
see
FHIR
(will
be
incorrect/inconsistent
at
times).
See
the
Directory
of
published
versions
.
Page
versions:
R4B
R4
R3
R2
Content
Detailed
Descriptions
Mappings
XML
JSON
Example
Patient/infant-twin-1
(Turtle)
URL
for
this
extension:
http://hl7.org/fhir/StructureDefinition/valueset-otherName
Status:
draft.
Extension
maintained
by:
HL7
Human
readable
names
for
the
valueset.
Context
of
Use:
Use
on
element:
ValueSet
usage
info:
insert
a
list
of
places
where
this
extension
is
used
Extension
Content
-
Summary
Narrative
Full
Structure
-
XML
-
JSON
All
-
TTL
Summary
Name
Flags
Card.
Type
Description
&
Constraints
extension
0..*
Extension
URL
=
http://hl7.org/fhir/StructureDefinition/valueset-otherName
otherName:
Human
readable
names
for
the
valueset.
Use
on
element:
ValueSet
name
1..1
string
This
name
is
intended
to
be
human
readable,
short
and
as
specific
as
possible
and
to
convey
the
purpose
of
the
value
set.
It
is
considered
to
be
the
name
of
the
value
set.
preferred
0..1
boolean
Raw
Turtle
Flag
that
this
Name
in
this
Name
Language
is
the
preferred
human-readable
signifier
in
this
language.
Documentation
for
this
format
(+
also
see
Turtle/RDF
Format
Specification
Full
Structure
)
Name
Flags
Card.
Type
Description
&
Constraints
extension
0..*
Extension
URL
=
http://hl7.org/fhir/StructureDefinition/valueset-otherName
otherName:
Human
readable
names
for
the
valueset.
Use
on
element:
ValueSet
extension
1..1
Extension
Human
readable,
short
and
specific
url
1..1
uri
"name"
valueString
0..1
string
Value
of
extension
extension
0..1
Extension
Which
name
is
preferred
for
this
language
url
1..1
uri
"preferred"
valueBoolean
0..1
boolean
Value
of
extension
url
1..1
uri
"http://hl7.org/fhir/StructureDefinition/valueset-otherName"
value[x]
0
..
0
Documentation
for
this
format
XML
Template
Newborn
Eldest
Twin
Example
<!-- otherName -->
@prefix fhir: <http://hl7.org/fhir/> .
@prefix owl: <http://www.w3.org/2002/07/owl#> .
@prefix rdf: <http://www.w3.org/1999/02/22-rdf-syntax-ns#> .
@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
@prefix sct: <http://snomed.info/id/> .
@prefix xsd: <http://www.w3.org/2001/XMLSchema#> .
# - resource -------------------------------------------------------------------
<http://hl7.org/fhir/Patient/infant-twin-1> a fhir:Patient ;
fhir:nodeRole fhir:treeRoot ;
fhir:id [ fhir:v "infant-twin-1"] ; # newborn twin example
fhir:extension ( [
fhir:url [
fhir:v "http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName"^^xsd:anyURI ;
fhir:l <http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName>
] ;
fhir:value [
a fhir:String ;
fhir:v "Organa"
]
] ) ; # The details of the child
fhir:identifier ( [
fhir:type [
fhir:coding ( [
fhir:system [
fhir:v "http://terminology.hl7.org/CodeSystem/v2-0203"^^xsd:anyURI ;
fhir:l <http://terminology.hl7.org/CodeSystem/v2-0203>
] ;
fhir:code [ fhir:v "MR" ]
] )
] ;
fhir:system [
fhir:v "http://coruscanthealth.org/main-hospital/patient-identifier"^^xsd:anyURI ;
fhir:l <http://coruscanthealth.org/main-hospital/patient-identifier>
] ;
fhir:value [ fhir:v "MRN7465737865" ]
] [
fhir:system [
fhir:v "http://new-republic.gov/galactic-citizen-identifier"^^xsd:anyURI ;
fhir:l <http://new-republic.gov/galactic-citizen-identifier>
] ;
fhir:value [ fhir:v "7465737865" ]
] ) ; #
fhir:name ( [
fhir:use [ fhir:v "official" ] ;
fhir:family [ fhir:v "Solo" ] ;
fhir:given ( [ fhir:v "Jaina" ] )
] ) ; #
fhir:gender [ fhir:v "female"] ; #
fhir:birthDate [
fhir:v "2017-05-15"^^xsd:date ;
fhir:extension ( [
fhir:url [
fhir:v "http://hl7.org/fhir/StructureDefinition/patient-birthTime"^^xsd:anyURI ;
fhir:l <http://hl7.org/fhir/StructureDefinition/patient-birthTime>
] ;
fhir:value [
a fhir:DateTime ;
fhir:v "2017-05-15T17:11:00+01:00"^^xsd:dateTime
]
] )
] ; #
fhir:multipleBirth [
a fhir:Integer ;
fhir:v 1
] ; #
fhir:contact ( [
fhir:relationship ( [
fhir:coding ( [
a sct:72705000 ;
fhir:system [
fhir:v "http://snomed.info/sct"^^xsd:anyURI ;
fhir:l <http://snomed.info/sct>
] ;
fhir:code [ fhir:v "72705000" ] ;
fhir:display [ fhir:v "Mother" ]
] [
fhir:system [
fhir:v "http://terminology.hl7.org/CodeSystem/v2-0131"^^xsd:anyURI ;
fhir:l <http://terminology.hl7.org/CodeSystem/v2-0131>
] ;
fhir:code [ fhir:v "N" ]
] [
fhir:system [
fhir:v "http://terminology.hl7.org/CodeSystem/v3-RoleCode"^^xsd:anyURI ;
fhir:l <http://terminology.hl7.org/CodeSystem/v3-RoleCode>
] ;
fhir:code [ fhir:v "MTH" ]
] ) # Indicates that the contact is the patient's mother
] ) ; # Contact of the patient
fhir:name [
fhir:use [ fhir:v "maiden" ] ;
fhir:family [ fhir:v "Organa" ] ;
fhir:given ( [ fhir:v "Leia" ] )
] ;
fhir:telecom ( [
fhir:system [ fhir:v "phone" ] ;
fhir:value [ fhir:v "+31201234567" ] ;
fhir:use [ fhir:v "mobile" ]
] )
] ) . #
# -------------------------------------------------------------------------------------
< xmlns="http://hl7.org/fhir"
url="" >
<
<
</extension>
<
<
</extension>
</extension>
JSON
Template
{ //
"
{ //
// from Element:
"
],
"
"
},
{ //
// from Element:
"
],
"
"
}
],
"
}
Summary
Name
Flags
Card.
Type
Description
&
Constraints
extension
0..*
Extension
URL
=
http://hl7.org/fhir/StructureDefinition/valueset-otherName
otherName:
Human
readable
names
for
the
valueset.
Use
on
element:
ValueSet
name
1..1
string
This
name
is
intended
to
be
human
readable,
short
and
as
specific
as
possible
and
to
convey
the
purpose
of
the
value
set.
It
is
considered
Usage
note:
every
effort
has
been
made
to
be
the
name
of
the
value
set.
preferred
0..1
boolean
Flag
ensure
that
this
Name
in
this
Name
Language
is
the
preferred
human-readable
signifier
in
this
language.
Documentation
for
this
format
Full
Structure
Name
Flags
Card.
Type
Description
&
Constraints
extension
0..*
Extension
URL
=
http://hl7.org/fhir/StructureDefinition/valueset-otherName
otherName:
Human
readable
names
for
the
valueset.
Use
on
element:
ValueSet
extension
1..1
Extension
Human
readable,
short
examples
are
correct
and
specific
url
1..1
uri
"name"
valueString
0..1
string
Value
of
extension
extension
0..1
Extension
Which
name
is
preferred
for
this
language
url
1..1
uri
"preferred"
valueBoolean
0..1
boolean
Value
useful,
but
they
are
not
a
normative
part
of
extension
url
1..1
uri
"http://hl7.org/fhir/StructureDefinition/valueset-otherName"
value[x]
0
..
0
Documentation
for
this
format
XML
Template
the
specification.
<!-- otherName -->
< xmlns="http://hl7.org/fhir"
url="" >
<
<
</extension>
<
<
</extension>
</extension>
JSON
Template
{ //
"
{ //
// from Element:
"
],
"
"
},
{ //
// from Element:
"
],
"
"
}
],
"
}
Constraints
ele-1
:
All
FHIR
elements
must
have
a
@value
or
children
(xpath:
@value|f:*|h:div
)
ext-1
:
Must
have
either
extensions
or
value[x],
not
both
(xpath:
exists(f:extension)!=exists(f:*[starts-with(local-name(.),
'value')])
)