CompartmentDefinition - FHIR Resource (stu3)
This CompartmentDefinition Resource uses the FHIR API standard for access and structure.
Validate an CompartmentDefinition FHIR Resource (stu3)
CompartmentDefinition Attributes
AttributeField is listTypeDescription
Description: draft | active | retired | unknown
FHIR Version: stu3
Attribute Type : code
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"status": "draft"Learn more about the (CompartmentDefinition) status FHIR attribute
Description: Name of the publisher (organization or individual)
FHIR Version: stu3
Attribute Type : string
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"publisher": "Health Level Seven International (FHIR Infrastructure)"Learn more about the (CompartmentDefinition) publisher FHIR attribute
Description: Whether the search syntax is supported
FHIR Version: stu3
Attribute Type : boolean
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"search": trueLearn more about the (CompartmentDefinition) search FHIR attribute
Description: Patient | Encounter | RelatedPerson | Practitioner | Device
FHIR Version: stu3
Attribute Type : code
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"code": "Device"Learn more about the (CompartmentDefinition) code FHIR attribute
Description: How a resource is related to the compartment
FHIR Version: stu3
Attribute Type : Data Type
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"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"
}
]Learn more about the (CompartmentDefinition) resource FHIR attribute
Description: Name for this compartment definition (computer friendly)
FHIR Version: stu3
Attribute Type : string
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"name": "EXAMPLE"Learn more about the (CompartmentDefinition) name FHIR attribute
Description: Name for this compartment definition (human friendly)
FHIR Version: stu3
Attribute Type : string
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"title": "Base FHIR compartment definition for Device(example)"Learn more about the (CompartmentDefinition) title FHIR attribute
Description: Logical URI to reference this compartment definition (globally unique)
FHIR Version: stu3
Attribute Type : uri
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"url": "http://hl7.org/fhir/CompartmentDefinition/example"Learn more about the (CompartmentDefinition) url FHIR attribute
Description: Intended jurisdiction for compartment definition (if applicable)
FHIR Version: stu3
Attribute Type : CodeableConcept
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"jurisdiction": [
{
"coding": [
{
"code": "US",
"system": "urn:iso:std:iso:3166",
"display": "United States of America (the)"
}
]
}
]Learn more about the (CompartmentDefinition) jurisdiction FHIR attribute
Description: Contact details for the publisher
FHIR Version: stu3
Attribute Type : ContactDetail
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
}
],
"name": "[string]"
}
]Learn more about the (CompartmentDefinition) contact FHIR attribute
Description: Context the content is intended to support
FHIR Version: stu3
Attribute Type : UsageContext
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"useContext": [
{
"valueCodeableConcept": {
"coding": [
{
"code": "Device",
"system": "http://hl7.org/fhir/resource-types"
}
]
},
"code": {
"code": "focus",
"system": "http://hl7.org/fhir/usage-context-type"
}
}
]Learn more about the (CompartmentDefinition) useContext FHIR attribute
Description: Why this compartment definition is defined
FHIR Version: stu3
Attribute Type : markdown
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"purpose": "Provides an example of a FHIR compartment definition based on the Device resource type."Learn more about the (CompartmentDefinition) purpose FHIR attribute
Description: Date this was last changed
FHIR Version: stu3
Attribute Type : dateTime
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"date": "2017-02-24"Learn more about the (CompartmentDefinition) date FHIR attribute
Description: For testing purposes, not real usage
FHIR Version: stu3
Attribute Type : boolean
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"experimental": trueLearn more about the (CompartmentDefinition) experimental FHIR attribute
Description: Natural language description of the compartment definition
FHIR Version: stu3
Attribute Type : markdown
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"description": "The set of resources associated with a particular Device (example with Communication and CommunicationRequest resourses only)."Learn more about the (CompartmentDefinition) description FHIR attribute
CompartmentDefinition Example
{
"status": "draft",
"publisher": "Health Level Seven International (FHIR Infrastructure)",
"search": true,
"code": "Device",
"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"
}
],
"name": "EXAMPLE",
"title": "Base FHIR compartment definition for Device(example)",
"resourceType": "CompartmentDefinition",
"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>: <a>http://hl7.org/fhir/CompartmentDefinition/example</a></p><p><b>name</b>: EXAMPLE</p><p><b>title</b>: Base FHIR compartment definition for Device(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>purpose</b>: Provides an example of a FHIR compartment definition based on the Device resource type.</p><p><b>useContext</b>: </p><p><b>jurisdiction</b>: United States of America (the) <span>(Details : {urn:iso:std:iso:3166 code 'US' = 'United States', given as 'United States of America (the)'})</span></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>"
},
"jurisdiction": [
{
"coding": [
{
"code": "US",
"system": "urn:iso:std:iso:3166",
"display": "United States of America (the)"
}
]
}
],
"url": "http://hl7.org/fhir/CompartmentDefinition/example",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
}
],
"name": "[string]"
}
],
"useContext": [
{
"valueCodeableConcept": {
"coding": [
{
"code": "Device",
"system": "http://hl7.org/fhir/resource-types"
}
]
},
"code": {
"code": "focus",
"system": "http://hl7.org/fhir/usage-context-type"
}
}
],
"purpose": "Provides an example of a FHIR compartment definition based on the Device resource type.",
"date": "2017-02-24",
"id": "example",
"experimental": true,
"description": "The set of resources associated with a particular Device (example with Communication and CommunicationRequest resourses only)."
}CompartmentDefinition Structure
{
"resourceType" : "CompartmentDefinition",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"url" : "<uri>", // R! Logical URI to reference this compartment definition (globally unique)
"name" : "<string>", // R! Name for this compartment definition (computer friendly)
"title" : "<string>", // Name for this compartment definition (human friendly)
"status" : "<code>", // R! draft | active | retired | unknown
"experimental" : <boolean>, // For testing purposes, not real usage
"date" : "<dateTime>", // Date this was last changed
"publisher" : "<string>", // Name of the publisher (organization or individual)
"contact" : [{ ContactDetail }], // Contact details for the publisher
"description" : "<markdown>", // Natural language description of the compartment definition
"purpose" : "<markdown>", // Why this compartment definition is defined
"useContext" : [{ UsageContext }], // Context the content is intended to support
"jurisdiction" : [{ CodeableConcept }], // Intended jurisdiction for compartment definition (if applicable)
"code" : "<code>", // R! Patient | Encounter | RelatedPerson | Practitioner | Device
"search" : <boolean>, // R! Whether the search syntax is supported
"resource" : [{ // How a resource is related to the compartment
"code" : "<code>", // R! Name of resource type
"param" : ["<string>"], // Search Parameter Name, or chained parameters
"documentation" : "<string>" // Additional documentation about the resource and compartment
}]
}
CompartmentDefinition Search Parameters
The following search parameters can be used to query CompartmentDefinition resources. Just submit them like so:
https://api.1up.health/fhir/stu3/CompartmentDefinition?query-param=queryvalue| Search Parameter | Field Type | Resource Fields Searched |
|---|---|---|
code | text | code |
date | date | date |
description | text | description |
jurisdiction | text | jurisdiction |
name | text | name |
publisher | text | publisher |
resource | text | resource.code |
status | text | status |
title | text | title |
url | uri | url |
