Medications
This
page
is
part
of
the
FHIR
Specification
(v3.0.2:
STU
(v5.0.0-ballot:
R5
Ballot
-
see
ballot
notes
3).
).
The
current
version
which
supercedes
this
version
is
5.0.0
.
For
a
full
list
of
available
versions,
see
the
Directory
of
published
versions
.
Page
versions:
R5
R4B
R4
R3
|
Public
Health
and
Emergency
Response
|
|
Standards Status : Informative |
|
This
structure
is
derived
from
Observation
.
Summary
Extensions
This
structure
refers
to
these
extensions:
http://hl7.org/fhir/StructureDefinition/observation-geneticsDNASequenceVariantName
http://hl7.org/fhir/StructureDefinition/observation-geneticsDNAVariantId
http://hl7.org/fhir/StructureDefinition/observation-geneticsDNASequenceVariantType
http://hl7.org/fhir/StructureDefinition/observation-geneticsAminoAcidChangeName
http://hl7.org/fhir/StructureDefinition/observation-geneticsAminoAcidChangeType
http://hl7.org/fhir/StructureDefinition/observation-geneticsGene
http://hl7.org/fhir/StructureDefinition/observation-geneticsDNARegionName
http://hl7.org/fhir/StructureDefinition/observation-geneticsAlleleName
http://hl7.org/fhir/StructureDefinition/observation-geneticsAllelicState
http://hl7.org/fhir/StructureDefinition/observation-geneticsAllelicFrequency
http://hl7.org/fhir/StructureDefinition/observation-geneticsCopyNumberEvent
http://hl7.org/fhir/StructureDefinition/observation-geneticsGenomicSourceClass
http://hl7.org/fhir/StructureDefinition/observation-geneticsPhaseSet
http://hl7.org/fhir/StructureDefinition/observation-geneticsSequence
http://hl7.org/fhir/StructureDefinition/observation-geneticsInterpretation
Differential
View
This
structure
is
derived
from
Observation
.
Name
Flags
Card.
Type
Description
&
Constraints
Observation
0
..
*
observation-geneticsDNASequenceVariantName
0
..
1
CodeableConcept
DNA
sequence
variant
URL:
http://hl7.org/fhir/StructureDefinition/observation-geneticsDNASequenceVariantName
Binding:
????
(
preferred
)
observation-geneticsDNAVariantId
0
..
1
CodeableConcept
DNA
sequence
variant
ID
URL:
http://hl7.org/fhir/StructureDefinition/observation-geneticsDNAVariantId
observation-geneticsDNASequenceVariantType
0
..
1
CodeableConcept
DNA
sequence
variant
type
URL:
http://hl7.org/fhir/StructureDefinition/observation-geneticsDNASequenceVariantType
observation-geneticsAminoAcidChangeName
0
..
1
CodeableConcept
Amino
acid
change
URL:
http://hl7.org/fhir/StructureDefinition/observation-geneticsAminoAcidChangeName
Binding:
????
(
preferred
)
observation-geneticsAminoAcidChangeType
0
..
1
CodeableConcept
Amino
Acid
Change
Type
URL:
http://hl7.org/fhir/StructureDefinition/observation-geneticsAminoAcidChangeType
observation-geneticsGene
0
..
1
CodeableConcept
HGNC
gene
symbol
URL:
http://hl7.org/fhir/StructureDefinition/observation-geneticsGene
Binding:
????
(
preferred
)
observation-geneticsDNARegionName
0
..
1
string
DNA
region
name
URL:
http://hl7.org/fhir/StructureDefinition/observation-geneticsDNARegionName
observation-geneticsAlleleName
0
..
1
CodeableConcept
Name
of
allele
URL:
http://hl7.org/fhir/StructureDefinition/observation-geneticsAlleleName
Binding:
????
(
preferred
)
observation-geneticsAllelicState
0
..
1
CodeableConcept
The
level
of
occurrence
of
a
single
DNA
sequence
variant
within
a
set
of
chromosomes:
Heteroplasmic
/
Homoplasmic
/
Homozygous
/
Heterozygous
/
Hemizygous
URL:
http://hl7.org/fhir/StructureDefinition/observation-geneticsAllelicState
observation-geneticsAllelicFrequency
0
..
1
decimal
Allele
frequency
URL:
http://hl7.org/fhir/StructureDefinition/observation-geneticsAllelicFrequency
observation-geneticsCopyNumberEvent
0
..
1
CodeableConcept
Copy
number
variation
URL:
http://hl7.org/fhir/StructureDefinition/observation-geneticsCopyNumberEvent
observation-geneticsGenomicSourceClass
0
..
1
CodeableConcept
Genomic
source
class
URL:
http://hl7.org/fhir/StructureDefinition/observation-geneticsGenomicSourceClass
observation-geneticsPhaseSet
0
..
1
uri
Phase
set
identifier
(UUID/OID)
URL:
http://hl7.org/fhir/StructureDefinition/observation-geneticsPhaseSet
observation-geneticsSequence
0
..
*
Reference
(
Sequence
)
Sequence
URL:
http://hl7.org/fhir/StructureDefinition/observation-geneticsSequence
observation-geneticsInterpretation
0
..
1
Reference
(
Observation
)
Clinical
interpretations
for
variant
URL:
http://hl7.org/fhir/StructureDefinition/observation-geneticsInterpretation
Documentation
for
this
format
Snapshot
View
Name
Flags
Card.
Type
Description
&
Constraints
Observation
I
0..*
Measurements
and
simple
assertions
id
Σ
0..1
id
Logical
id
of
this
artifact
meta
Σ
0..1
Meta
Metadata
about
the
resource
implicitRules
?!
Σ
0..1
uri
A
set
of
rules
under
which
this
content
was
created
language
0..1
code
Language
of
the
resource
content
Binding:
Common
Languages
(
extensible
)
text
I
0..1
Narrative
Text
summary
representation
of
the
resource,
for
human
interpretation
contained
0..*
Resource
Contained,
inline
Resources
observation-geneticsDNASequenceVariantName
I
0..1
CodeableConcept
DNA
sequence
variant
URL:
http://hl7.org/fhir/StructureDefinition/observation-geneticsDNASequenceVariantName
Binding:
????
(
preferred
)
observation-geneticsDNAVariantId
I
0..1
CodeableConcept
DNA
sequence
variant
ID
URL:
http://hl7.org/fhir/StructureDefinition/observation-geneticsDNAVariantId
observation-geneticsDNASequenceVariantType
I
0..1
CodeableConcept
DNA
sequence
variant
type
URL:
http://hl7.org/fhir/StructureDefinition/observation-geneticsDNASequenceVariantType
observation-geneticsAminoAcidChangeName
I
0..1
CodeableConcept
Amino
acid
change
URL:
http://hl7.org/fhir/StructureDefinition/observation-geneticsAminoAcidChangeName
Binding:
????
(
preferred
)
observation-geneticsAminoAcidChangeType
I
0..1
CodeableConcept
Amino
Acid
Change
Type
URL:
http://hl7.org/fhir/StructureDefinition/observation-geneticsAminoAcidChangeType
observation-geneticsGene
I
0..1
CodeableConcept
HGNC
gene
symbol
URL:
http://hl7.org/fhir/StructureDefinition/observation-geneticsGene
Binding:
????
(
preferred
)
observation-geneticsDNARegionName
I
0..1
string
DNA
region
name
URL:
http://hl7.org/fhir/StructureDefinition/observation-geneticsDNARegionName
observation-geneticsAlleleName
I
0..1
CodeableConcept
Name
of
allele
URL:
http://hl7.org/fhir/StructureDefinition/observation-geneticsAlleleName
Binding:
????
(
preferred
)
observation-geneticsAllelicState
I
0..1
CodeableConcept
The
level
of
occurrence
of
a
single
DNA
sequence
variant
within
a
set
of
chromosomes:
Heteroplasmic
/
Homoplasmic
/
Homozygous
/
Heterozygous
/
Hemizygous
URL:
http://hl7.org/fhir/StructureDefinition/observation-geneticsAllelicState
observation-geneticsAllelicFrequency
I
0..1
decimal
Allele
frequency
URL:
http://hl7.org/fhir/StructureDefinition/observation-geneticsAllelicFrequency
observation-geneticsCopyNumberEvent
I
0..1
CodeableConcept
Copy
number
variation
URL:
http://hl7.org/fhir/StructureDefinition/observation-geneticsCopyNumberEvent
observation-geneticsGenomicSourceClass
I
0..1
CodeableConcept
Genomic
source
class
URL:
http://hl7.org/fhir/StructureDefinition/observation-geneticsGenomicSourceClass
observation-geneticsPhaseSet
I
0..1
uri
Phase
set
identifier
(UUID/OID)
URL:
http://hl7.org/fhir/StructureDefinition/observation-geneticsPhaseSet
observation-geneticsSequence
I
0..*
Reference
(
Sequence
)
Sequence
URL:
http://hl7.org/fhir/StructureDefinition/observation-geneticsSequence
observation-geneticsInterpretation
I
0..1
Reference
(
Observation
)
Clinical
interpretations
for
variant
URL:
http://hl7.org/fhir/StructureDefinition/observation-geneticsInterpretation
modifierExtension
?!
0..*
Extension
Extensions
that
cannot
be
ignored
identifier
Σ
0..*
Identifier
Business
Identifier
json
schema
for
observation
basedOn
Σ
0..*
Reference
(
CarePlan
),
Reference
(
DeviceRequest
),
Reference
(
ImmunizationRecommendation
),
Reference
(
MedicationRequest
),
Reference
(
NutritionOrder
),
Reference
(
ProcedureRequest
),
Reference
(
ReferralRequest
)
Fulfills
plan,
proposal
or
order
status
?!
Σ
1..1
code
registered
|
preliminary
|
final
|
amended
+
Binding:
ObservationStatus
(
required
)
category
0..*
CodeableConcept
Classification
of
type
of
observation
Binding:
Observation
Category
Codes
(
preferred
)
code
Σ
1..1
CodeableConcept
Type
of
observation
(code
/
type)
Binding:
LOINC
Codes
(
example
)
subject
Σ
0..1
Reference
(
Patient
),
Reference
(
Group
),
Reference
(
Device
),
Reference
(
Location
)
Who
and/or
what
this
is
about
context
0..1
Reference
(
Encounter
),
Reference
(
EpisodeOfCare
)
Healthcare
event
during
ImmunizationEvaluation,
which
this
observation
is
made
effective[x]
Σ
0..1
dateTime
,
Period
Clinically
relevant
time/time-period
for
observation
issued
Σ
0..1
instant
Date/Time
this
was
made
available
performer
Σ
0..*
Reference
(
Practitioner
),
Reference
(
Organization
),
Reference
(
Patient
),
Reference
(
RelatedPerson
)
Who
is
responsible
for
the
observation
value[x]
Σ
I
0..1
Quantity
,
CodeableConcept
,
string
,
boolean
,
Range
,
Ratio
,
SampledData
,
Attachment
,
time
,
dateTime
,
Period
Actual
result
dataAbsentReason
I
0..1
CodeableConcept
Why
the
result
is
missing
Binding:
Observation
Value
Absent
Reason
(
extensible
)
interpretation
0..1
CodeableConcept
High,
low,
normal,
etc.
Binding:
Observation
Interpretation
Codes
(
extensible
)
comment
0..1
string
Comments
about
result
bodySite
0..1
CodeableConcept
Observed
body
part
Binding:
SNOMED
CT
Body
Structures
(
example
)
method
0..1
CodeableConcept
How
it
was
done
Binding:
Observation
Methods
(
example
)
specimen
0..1
Reference
(
Specimen
)
Specimen
used
for
this
observation
device
0..1
Reference
(
Device
),
Reference
(
DeviceMetric
)
(Measurement)
Device
referenceRange
I
0..*
BackboneElement
Provides
guide
for
interpretation
obs-3:
Must
have
at
least
a
low
or
just
a
high
or
text
id
0..1
string
xml:id
(or
equivalent
in
JSON)
extension
0..*
Extension
Additional
Content
defined
by
implementations
modifierExtension
?!
Σ
0..*
Extension
Extensions
that
cannot
be
ignored
low
I
0..1
SimpleQuantity
Low
Range,
if
relevant
high
I
0..1
SimpleQuantity
High
Range,
if
relevant
type
0..1
CodeableConcept
Reference
range
qualifier
Binding:
Observation
Reference
Range
Meaning
Codes
(
extensible
)
appliesTo
0..*
CodeableConcept
Reference
range
population
Binding:
Observation
Reference
Range
Applies
To
Codes
(
example
)
age
0..1
Range
Applicable
age
range,
if
relevant
text
0..1
string
Text
based
reference
range
in
an
observation
related
Σ
I
0..*
BackboneElement
Resource
related
to
this
observation
id
0..1
string
xml:id
(or
equivalent
in
JSON)
extension
0..*
Extension
Additional
Content
defined
by
implementations
modifierExtension
?!
Σ
0..*
Extension
Extensions
that
cannot
be
ignored
type
0..1
code
has-member
|
derived-from
|
sequel-to
|
replaces
|
qualified-by
|
interfered-by
Binding:
ObservationRelationshipType
(
required
)
target
1..1
Reference
(
Observation
),
Reference
(
QuestionnaireResponse
),
Reference
(
Sequence
)
Resource
that
is
related
to
this
one
component
Σ
I
0..*
BackboneElement
Component
results
id
0..1
string
xml:id
(or
equivalent
in
JSON)
extension
0..*
Extension
Additional
Content
defined
by
implementations
modifierExtension
?!
Σ
0..*
Extension
Extensions
that
cannot
be
ignored
code
Σ
1..1
CodeableConcept
Type
part
of
component
observation
(code
/
type)
Binding:
LOINC
Codes
(
example
)
value[x]
Σ
0..1
Quantity
,
CodeableConcept
,
string
,
Range
,
Ratio
,
SampledData
,
Attachment
,
time
,
dateTime
,
Period
Actual
component
result
dataAbsentReason
I
0..1
CodeableConcept
Why
the
component
result
is
missing
Binding:
Observation
Value
Absent
Reason
(
extensible
)
interpretation
0..1
CodeableConcept
High,
low,
normal,
etc.
Binding:
Observation
Interpretation
Codes
(
extensible
)
referenceRange
0..*
Unknown
reference
to
#Observation.referenceRange
Provides
guide
for
interpretation
of
component
result
Documentation
for
this
format
XML
Template
<!-- Observation-genetics -->
< xmlns="http://hl7.org/fhir"
>
<!-- from Element: -->
<
<</meta>
<
<
<
Text summary of the resource, for human interpretation</text>
<</contained>
<</modifierExtension>
<
Business Identifier for observation</identifier>
<)|
</basedOn>
<
<</category>
<</code>
<
Who and/or what this is about</subject>
<
Healthcare event during which this observation is made</context>
<
Clinically relevant time/time-period for observation</effective[x]>
<
<
Who is responsible for the observation</performer>
<|
</value[x]>
<</dataAbsentReason>
<</interpretation>
<
<</bodySite>
<</method>
<</specimen>
<</device>
<
<</modifierExtension>
<
Low Range, if relevant</low>
<
High Range, if relevant</high>
<</type>
<</appliesTo>
<
Applicable age range, if relevant</age>
<
</referenceRange>
<
<</modifierExtension>
<
<
Resource that is related to this one</target>
</related>
<
<</modifierExtension>
<</code>
<|
Actual component result</value[x]>
<</dataAbsentReason>
<</interpretation>
<</referenceRange>
</component>
</Observation>
full
JSON
Template
Schema
.
{
"$schema": "http://json-schema.org/draft-06/schema#",
"id": "http://hl7.org/fhir/json-schema/ImmunizationEvaluation",
"$ref": "#/definitions/ImmunizationEvaluation",
"description": "see http://hl7.org/fhir/json.html#schema for information about the FHIR Json Schemas",
"definitions": {
"ImmunizationEvaluation": {
"description": "Describes a comparison of an immunization event against published recommendations to determine if the administration is \"valid\" in relation to those recommendations.",
"properties": {
"resourceType": {
"description": "This is a ImmunizationEvaluation resource",
"const": "ImmunizationEvaluation"
},
"id": {
"description": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"$ref": "id.schema.json#/definitions/id"
},
"meta": {
"description": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"$ref": "Meta.schema.json#/definitions/Meta"
},
"implicitRules": {
"description": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"$ref": "#/definitions/uri"
},
"_implicitRules": {
"description": "Extensions for implicitRules",
"$ref": "Element.schema.json#/definitions/Element"
},
"language": {
"description": "The base language in which the resource is written.",
"$ref": "#/definitions/code"
},
"_language": {
"description": "Extensions for language",
"$ref": "Element.schema.json#/definitions/Element"
},
"text": {
"description": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"$ref": "Narrative.schema.json#/definitions/Narrative"
},
"contained": {
"description": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.",
"items": {
"$ref": "ResourceList.schema.json#/definitions/ResourceList"
},
"type": "array"
},
"extension": {
"description": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"modifierExtension": {
"description": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"items": {
"$ref": "Extension.schema.json#/definitions/Extension"
},
"type": "array"
},
"identifier": {
"description": "A unique identifier assigned to this immunization evaluation record.",
"items": {
"$ref": "Identifier.schema.json#/definitions/Identifier"
},
"type": "array"
},
"status": {
"description": "Indicates the current status of the evaluation of the vaccination administration event.",
"$ref": "#/definitions/code"
},
"_status": {
"description": "Extensions for status",
"$ref": "Element.schema.json#/definitions/Element"
},
"patient": {
"description": "The individual for whom the evaluation is being done.",
"$ref": "Reference.schema.json#/definitions/Reference"
},
"date": {
"description": "The date the evaluation of the vaccine administration event was performed.",
"$ref": "#/definitions/dateTime"
},
"_date": {
"description": "Extensions for date",
"$ref": "Element.schema.json#/definitions/Element"
},
"authority": {
"description": "Indicates the authority who published the protocol (e.g. ACIP).",
"$ref": "Reference.schema.json#/definitions/Reference"
},
"targetDisease": {
"description": "The vaccine preventable disease the dose is being evaluated against.",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"immunizationEvent": {
"description": "The vaccine administration event being evaluated.",
"$ref": "Reference.schema.json#/definitions/Reference"
},
"doseStatus": {
"description": "Indicates if the dose is valid or not valid with respect to the published recommendations.",
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"doseStatusReason": {
"description": "Provides an explanation as to why the vaccine administration event is valid or not relative to the published recommendations.",
"items": {
"$ref": "CodeableConcept.schema.json#/definitions/CodeableConcept"
},
"type": "array"
},
"description": {
"description": "Additional information about the evaluation.",
"$ref": "#/definitions/string"
},
"_description": {
"description": "Extensions for description",
"$ref": "Element.schema.json#/definitions/Element"
},
"series": {
"description": "One possible path to achieve presumed immunity against a disease - within the context of an authority.",
"$ref": "#/definitions/string"
},
"_series": {
"description": "Extensions for series",
"$ref": "Element.schema.json#/definitions/Element"
},
"doseNumber": {
"description": "Nominal position in a series as determined by the outcome of the evaluation process.",
"$ref": "#/definitions/string"
},
"_doseNumber": {
"description": "Extensions for doseNumber",
"$ref": "Element.schema.json#/definitions/Element"
},
"seriesDoses": {
"description": "The recommended number of doses to achieve immunity as determined by the outcome of the evaluation process.",
"$ref": "#/definitions/string"
},
"_seriesDoses": {
"description": "Extensions for seriesDoses",
"$ref": "Element.schema.json#/definitions/Element"
}
},
{ //
// from Element:
}
],
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"
"type": "object",
"additionalProperties": false,
"required": [
"doseStatus",
"patient",
"targetDisease",
"immunizationEvent",
"resourceType"
]
}
}
}
FHIR
®©
HL7.org
2011+.
FHIR
Release
3
(STU;
v3.0.2-11200)
R5
Ballot
hl7.fhir.core#5.0.0-ballot
generated
on
Thurs,
Oct
24,
2019
11:53+1100.
QA
Page
Sat,
Sep
10,
2022
05:04+1000.
Links:
Search
|
Version
History
|
Table
of
Contents
|
Credits
Glossary
|
QA
|
Compare
to
DSTU2
R4B
|
Compare
to
R5
Draft
|
|
Propose
a
change