This
page
is
part
of
the
FHIR
Specification
(v4.0.1:
R4
(v4.3.0:
R4B
-
Mixed
Normative
and
STU
)
in
it's
permanent
home
(it
will
always
be
available
at
this
URL).
).
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
R4B
R4
R3
| FHIR Infrastructure Work Group | Maturity Level : N/A | Standards Status : Informative | Compartments : Not linked to any 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 with Details</b></p><p><b>id</b>: example</p><p><b>url</b>: <b>http://hl7.org/fhir/CompartmentDefinition/example</b></p><p><b>name</b>: EXAMPLE</p><p><b>status</b>: draft</p><p><b>experimental</b>: true</p><p><b>date</b>: 24/02/2017</p><p><b>publisher</b>: Health Level Seven International (FHIR Infrastructure)</p><p><b>contact</b>: </p><p><b>description</b>: The set of resources associated with a particular Device (example with Communication and CommunicationRequest resourses only).</p><p><b>useContext</b>: </p><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>"
"resourceType" : "CompartmentDefinition",
"id" : "example",
"text" : {
"status" : "generated",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p><b>Generated Narrative</b></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 "example" </p></div><p><b>url</b>: <code>http://hl7.org/fhir/CompartmentDefinition/example</code></p><p><b>name</b>: EXAMPLE</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><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>"
},
"url": "http://hl7.org/fhir/CompartmentDefinition/example",
"name": "EXAMPLE",
"status": "draft",
"experimental": true,
"date": "2017-02-24",
"publisher": "Health Level Seven International (FHIR Infrastructure)",
"contact": [
{
"name": "[string]",
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
}
]
}
],
"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/resource-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"
"url" : "http://hl7.org/fhir/CompartmentDefinition/example",
"name" : "EXAMPLE",
"status" : "draft",
"experimental" : true,
"date" : "2017-02-24",
"publisher" : "Health Level Seven International (FHIR Infrastructure)",
"contact" : [{
"name" : "[string]",
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
}]
}],
"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"
},
{
"code": "CommunicationRequest",
"param": [
"sender",
"recipient"
],
"documentation": "The device used as the message sender and recipient"
"valueCodeableConcept" : {
"coding" : [{
"system" : "http://hl7.org/fhir/resource-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.