Conformance
This
page
is
part
of
the
FHIR
Specification
(v5.0.0:
R5
-
STU
v6.0.0-ballot1:
Release
6
Ballot
(1st
Draft)
(see
Ballot
Notes
).
This
is
the
The
current
published
version
in
it's
permanent
home
(it
will
always
be
available
at
this
URL).
is
5.0.0
.
For
a
full
list
of
available
versions,
see
the
Directory
of
published
versions
.
Page
versions:
R5
R4B
R4
R3
| FHIR Infrastructure Work Group | Maturity Level : N/A | Standards Status : Informative | Compartments : No defined compartments |
Raw JSON ( canonical form + also see JSON Format Specification )
Example Compartment
{
"resourceType" : "CompartmentDefinition",
"id" : "example",
"text" : {
"status" : "generated",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p><b>Generated Narrative: CompartmentDefinition</b><a name=\"example\"> </a></p><div style=\"display: inline-block; background-color: #d9e0e7; padding: 6px; margin: 4px; border: 1px solid #8da1b4; border-radius: 5px; line-height: 60%\"><p style=\"margin-bottom: 0px\">Resource CompartmentDefinition "example" </p></div><p><b>url</b>: <code>http://hl7.org/fhir/CompartmentDefinition/example</code></p><p><b>name</b>: EXAMPLE</p><p><b>title</b>: E X A M P L E</p><p><b>status</b>: draft</p><p><b>experimental</b>: true</p><p><b>date</b>: 2017-02-24</p><p><b>publisher</b>: Health Level Seven International (FHIR Infrastructure)</p><p><b>contact</b>: [string]: <a href=\"http://hl7.org/fhir\">http://hl7.org/fhir</a></p><p><b>description</b>: The set of resources associated with a particular Device (example with Communication and CommunicationRequest resourses only).</p><h3>UseContexts</h3><table class=\"grid\"><tr><td>-</td><td><b>Code</b></td><td><b>Value[x]</b></td></tr><tr><td>*</td><td>Clinical Focus (Details: http://terminology.hl7.org/CodeSystem/usage-context-type code focus = 'Clinical Focus', stated as 'null')</td><td>Device <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> (<a href=\"codesystem-fhir-types.html\">All FHIR Types</a>#Device)</span></td></tr></table><p><b>purpose</b>: Provides an example of a FHIR compartment definition based on the Device resource type.</p><p><b>code</b>: Device</p><p><b>search</b>: true</p><blockquote><p><b>resource</b></p><p><b>code</b>: Communication</p><p><b>param</b>: sender, recipient</p><p><b>documentation</b>: The device used as the message sender and recipient</p></blockquote><blockquote><p><b>resource</b></p><p><b>code</b>: CommunicationRequest</p><p><b>param</b>: sender, recipient</p><p><b>documentation</b>: The device used as the message sender and recipient</p></blockquote></div>"
"status" : "extensions",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p><b>Generated Narrative: CompartmentDefinition</b><a name=\"example\"> </a></p><div style=\"display: inline-block; background-color: #d9e0e7; padding: 6px; margin: 4px; border: 1px solid #8da1b4; border-radius: 5px; line-height: 60%\"><p style=\"margin-bottom: 0px\">Resource CompartmentDefinition "example" </p></div><p><b>StructureDefinition Work Group</b>: fhir</p><p><b>url</b>: <code>http://hl7.org/fhir/CompartmentDefinition/example</code></p><p><b>name</b>: EXAMPLE</p><p><b>title</b>: E X A M P L E</p><p><b>status</b>: draft</p><p><b>experimental</b>: true</p><p><b>date</b>: 2017-02-24</p><p><b>publisher</b>: HL7 International / FHIR Infrastructure</p><p><b>contact</b>: <a href=\"http://www.hl7.org/Special/committees/fiwg\">http://www.hl7.org/Special/committees/fiwg</a>, <a href=\"http://www.hl7.org/Special/committees/fiwg/index.cfm\">http://www.hl7.org/Special/committees/fiwg/index.cfm</a></p><p><b>description</b>: The set of resources associated with a particular Device (example with Communication and CommunicationRequest resourses only).</p><h3>UseContexts</h3><table class=\"grid\"><tr><td style=\"display: none\">-</td><td><b>Code</b></td><td><b>Value[x]</b></td></tr><tr><td style=\"display: none\">*</td><td>Clinical Focus (Details: http://terminology.hl7.org/CodeSystem/usage-context-type code focus = 'Clinical Focus', stated as 'null')</td><td>Device <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> (<a href=\"codesystem-fhir-types.html\">All FHIR Types</a>#Device)</span></td></tr></table><p><b>purpose</b>: Provides an example of a FHIR compartment definition based on the Device resource type.</p><p><b>code</b>: Device</p><p><b>search</b>: true</p><blockquote><p><b>resource</b></p><p><b>code</b>: Communication</p><p><b>param</b>: sender, recipient</p><p><b>documentation</b>: The device used as the message sender and recipient</p></blockquote><blockquote><p><b>resource</b></p><p><b>code</b>: CommunicationRequest</p><p><b>param</b>: sender, recipient</p><p><b>documentation</b>: The device used as the message sender and recipient</p></blockquote></div>"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode" : "fhir"
}],
"url" : "http://hl7.org/fhir/CompartmentDefinition/example",
"name" : "EXAMPLE",
"title" : "E X A M P L E",
"status" : "draft",
"experimental" : true,
"date" : "2017-02-24",
"publisher" : "Health Level Seven International (FHIR Infrastructure)",
"publisher" : "HL7 International / FHIR Infrastructure",
"contact" : [{
"name" : "[string]",
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
"value" : "http://www.hl7.org/Special/committees/fiwg"
}]
},
{
"telecom" : [{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/fiwg/index.cfm"
}]
}],
"description" : "The set of resources associated with a particular Device (example with Communication and CommunicationRequest resourses only).",
"useContext" : [{
"code" : {
"system" : "http://terminology.hl7.org/CodeSystem/usage-context-type",
"code" : "focus"
},
"valueCodeableConcept" : {
"coding" : [{
"system" : "http://hl7.org/fhir/fhir-types",
"code" : "Device"
}]
}
}],
"purpose" : "Provides an example of a FHIR compartment definition based on the Device resource type.",
"code" : "Device",
"search" : true,
"resource" : [{
"code" : "Communication",
"param" : ["sender",
"recipient"],
"documentation" : "The device used as the message sender and recipient"
},
{
"code" : "CommunicationRequest",
"param" : ["sender",
"recipient"],
"documentation" : "The device used as the message sender and recipient"
}]
}
Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.
FHIR
®©
HL7.org
2011+.
FHIR
R5
hl7.fhir.core#5.0.0
R6
hl7.fhir.core#6.0.0-ballot1
generated
on
Sun,
Mar
26,
Mon,
Dec
18,
2023
15:24+1100.
15:16+1100.
Links:
Search
|
Version
History
|
Contents
|
Glossary
|
QA
|
Compare
to
R4
|
Compare
to
R4B
R5
|
|
Propose
a
change