ImplementationGuide - FHIR Resource (stu3)
This ImplementationGuide Resource uses the FHIR API standard for access and structure.
Validate an ImplementationGuide FHIR Resource (stu3)
ImplementationGuide 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 (ImplementationGuide) 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": "ONC / HL7 Joint project"Learn more about the (ImplementationGuide) publisher FHIR attribute
Description: Intended jurisdiction for implementation guide (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"
}
]
}
]Learn more about the (ImplementationGuide) jurisdiction 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": "2015-01-01"Learn more about the (ImplementationGuide) date FHIR attribute
Description: Name for this implementation guide (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": "Data Access Framework (DAF)"Learn more about the (ImplementationGuide) name FHIR attribute
Description: Use and/or publishing restrictions
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:
"copyright": "Published by ONC under the standard FHIR license (CC0)"Learn more about the (ImplementationGuide) copyright FHIR attribute
Description: Group of resources as used in .page.package
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:
"package": [
{
"resource": [
{
"description": "A test example to show how a package works",
"sourceUri": "test.html",
"acronym": "daf-tst",
"example": true,
"exampleFor": {
"reference": "StructureDefinition/daf-patient"
},
"name": "Test Example"
}
],
"name": "test",
"description": "Base package (not broken up into multiple packages)"
}
]Learn more about the (ImplementationGuide) package FHIR attribute
Description: Logical URI to reference this implementation guide (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/us/daf"Learn more about the (ImplementationGuide) url FHIR attribute
Description: Profiles that apply globally
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:
"global": [
{
"profile": {
"reference": "StructureDefinition/daf-patient"
},
"type": "Patient"
}
]Learn more about the (ImplementationGuide) global FHIR attribute
Description: Another Implementation guide this depends on
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:
"dependency": [
{
"type": "reference",
"uri": "http://hl7.org/fhir/ImplementationGuide/uscore"
}
]Learn more about the (ImplementationGuide) dependency 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://www.healthit.gov"
}
],
"name": "ONC"
},
{
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
}
],
"name": "HL7"
}
]Learn more about the (ImplementationGuide) 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": Learn more about the (ImplementationGuide) useContext FHIR attribute
Description: Business version of the implementation guide
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:
"version": "0"Learn more about the (ImplementationGuide) version FHIR attribute
Description: FHIR Version this Implementation Guide targets
FHIR Version: stu3
Attribute Type : id
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"fhirVersion": "1.0.0"Learn more about the (ImplementationGuide) fhirVersion FHIR attribute
Description: Image, css, script, etc.
FHIR Version: stu3
Attribute Type : uri
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"binary": [
"http://h7.org/fhir/fhir.css"
]Learn more about the (ImplementationGuide) binary FHIR attribute
Description: Page/Section in the Guide
FHIR Version: stu3
Attribute Type : Data Type
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"page": {
"source": "patient-example.html",
"kind": "page",
"page": [
{
"kind": "list",
"format": "text/html",
"package": [
"test"
],
"source": "list.html",
"title": "Value Set Page",
"type": [
"ValueSet"
]
}
],
"title": "Example Patient Page"
}Learn more about the (ImplementationGuide) page 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": falseLearn more about the (ImplementationGuide) experimental FHIR attribute
Description: Natural language description of the implementation guide
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 Data Access Framework (DAF) Initiative leverages the HL7 FHIR standards to standardize access to Meaningful Use Stage 2 structured information both within the organization and from external organizations"Learn more about the (ImplementationGuide) description FHIR attribute
ImplementationGuide Example
{
"status": "draft",
"publisher": "ONC / HL7 Joint project",
"package": [
{
"resource": [
{
"description": "A test example to show how a package works",
"sourceUri": "test.html",
"acronym": "daf-tst",
"example": true,
"exampleFor": {
"reference": "StructureDefinition/daf-patient"
},
"name": "Test Example"
}
],
"name": "test",
"description": "Base package (not broken up into multiple packages)"
}
],
"global": [
{
"profile": {
"reference": "StructureDefinition/daf-patient"
},
"type": "Patient"
}
],
"name": "Data Access Framework (DAF)",
"copyright": "Published by ONC under the standard FHIR license (CC0)",
"dependency": [
{
"type": "reference",
"uri": "http://hl7.org/fhir/ImplementationGuide/uscore"
}
],
"resourceType": "ImplementationGuide",
"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/us/daf</a></p><p><b>version</b>: 0</p><p><b>name</b>: Data Access Framework (DAF)</p><p><b>status</b>: draft</p><p><b>experimental</b>: false</p><p><b>date</b>: 01/01/2015</p><p><b>publisher</b>: ONC / HL7 Joint project</p><p><b>contact</b>: , </p><p><b>description</b>: The Data Access Framework (DAF) Initiative leverages the HL7 FHIR standards to standardize access to Meaningful Use Stage 2 structured information both within the organization and from external organizations</p><p><b>jurisdiction</b>: United States <span>(Details : {urn:iso:std:iso:3166 code 'US' = 'United States)</span></p><p><b>copyright</b>: Published by ONC under the standard FHIR license (CC0)</p><p><b>fhirVersion</b>: 1.0.0</p><h3>Dependencies</h3><table><tr><td>-</td><td><b>Type</b></td><td><b>Uri</b></td></tr><tr><td>*</td><td>reference</td><td><a>http://hl7.org/fhir/ImplementationGuide/uscore</a></td></tr></table><blockquote><p><b>package</b></p><p><b>name</b>: test</p><p><b>description</b>: Base package (not broken up into multiple packages)</p><h3>Resources</h3><table><tr><td>-</td><td><b>Example</b></td><td><b>Name</b></td><td><b>Description</b></td><td><b>Acronym</b></td><td><b>Source[x]</b></td><td><b>ExampleFor</b></td></tr><tr><td>*</td><td>true</td><td>Test Example</td><td>A test example to show how a package works</td><td>daf-tst</td><td><a>test.html</a></td><td><a>StructureDefinition/daf-patient</a></td></tr></table></blockquote><h3>Globals</h3><table><tr><td>-</td><td><b>Type</b></td><td><b>Profile</b></td></tr><tr><td>*</td><td>Patient</td><td><a>StructureDefinition/daf-patient</a></td></tr></table><p><b>binary</b>: <a>http://h7.org/fhir/fhir.css</a></p><blockquote><p><b>page</b></p><p><b>source</b>: <a>patient-example.html</a></p><p><b>title</b>: Example Patient Page</p><p><b>kind</b>: page</p><h3>Pages</h3><table><tr><td>-</td></tr><tr><td>*</td></tr></table></blockquote></div>"
},
"jurisdiction": [
{
"coding": [
{
"code": "US",
"system": "urn:iso:std:iso:3166"
}
]
}
],
"fhirVersion": "1.0.0",
"page": {
"source": "patient-example.html",
"kind": "page",
"page": [
{
"kind": "list",
"format": "text/html",
"package": [
"test"
],
"source": "list.html",
"title": "Value Set Page",
"type": [
"ValueSet"
]
}
],
"title": "Example Patient Page"
},
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://www.healthit.gov"
}
],
"name": "ONC"
},
{
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
}
],
"name": "HL7"
}
],
"url": "http://hl7.org/fhir/us/daf",
"version": "0",
"date": "2015-01-01",
"binary": [
"http://h7.org/fhir/fhir.css"
],
"id": "example",
"experimental": false,
"description": "The Data Access Framework (DAF) Initiative leverages the HL7 FHIR standards to standardize access to Meaningful Use Stage 2 structured information both within the organization and from external organizations"
}ImplementationGuide Structure
{
"resourceType" : "ImplementationGuide",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"url" : "<uri>", // R! Logical URI to reference this implementation guide (globally unique)
"version" : "<string>", // Business version of the implementation guide
"name" : "<string>", // R! Name for this implementation guide (computer 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 implementation guide
"useContext" : [{ UsageContext }], // Context the content is intended to support
"jurisdiction" : [{ CodeableConcept }], // Intended jurisdiction for implementation guide (if applicable)
"copyright" : "<markdown>", // Use and/or publishing restrictions
"fhirVersion" : "<id>", // FHIR Version this Implementation Guide targets
"dependency" : [{ // Another Implementation guide this depends on
"type" : "<code>", // R! reference | inclusion
"uri" : "<uri>" // R! Where to find dependency
}],
"package" : [{ // Group of resources as used in .page.package
"name" : "<string>", // R! Name used .page.package
"description" : "<string>", // Human readable text describing the package
"resource" : [{ // R! Resource in the implementation guide
"example" : <boolean>, // R! If not an example, has its normal meaning
"name" : "<string>", // Human Name for the resource
"description" : "<string>", // Reason why included in guide
"acronym" : "<string>", // Short code to identify the resource
// source[x]: Location of the resource. One of these 2:
"sourceUri" : "<uri>",
"sourceReference" : { Reference(Any) },
"exampleFor" : { Reference(StructureDefinition) } // Resource this is an example of (if applicable)
}]
}],
"global" : [{ // Profiles that apply globally
"type" : "<code>", // R! Type this profiles applies to
"profile" : { Reference(StructureDefinition) } // R! Profile that all resources must conform to
}],
"binary" : ["<uri>"], // Image, css, script, etc.
"page" : { // Page/Section in the Guide
"source" : "<uri>", // R! Where to find that page
"title" : "<string>", // R! Short title shown for navigational assistance
"kind" : "<code>", // R! page | example | list | include | directory | dictionary | toc | resource
"type" : ["<code>"], // Kind of resource to include in the list
"package" : ["<string>"], // Name of package to include
"format" : "<code>", // Format of the page (e.g. html, markdown, etc.)
"page" : [{ Content as for ImplementationGuide.page }] // Nested Pages / Sections
}
}
ImplementationGuide Search Parameters
The following search parameters can be used to query ImplementationGuide resources. Just submit them like so:
https://api.1up.health/fhir/stu3/ImplementationGuide?query-param=queryvalue| Search Parameter | Field Type | Resource Fields Searched |
|---|---|---|
date | date | date |
dependency | uri | dependency.uri |
description | text | description |
experimental | text | experimental |
jurisdiction | text | jurisdiction |
name | text | name |
publisher | text | publisher |
resource | reference | package.resource.source |
status | text | status |
url | uri | url |
version | text | version |
