ImplementationGuide - FHIR Resource (r4)
This ImplementationGuide Resource uses the FHIR API standard for access and structure.
Validate an ImplementationGuide FHIR Resource (r4)
ImplementationGuide Attributes
AttributeField is listTypeDescription
Description: Canonical identifier for this implementation guide, represented as a URI (globally unique)
FHIR Version: r4
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: Business version of the implementation guide
FHIR Version: r4
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: C? Name for this implementation guide (computer friendly)
FHIR Version: r4
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: Name for this implementation guide (human friendly)
FHIR Version: r4
Attribute Type : string
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"title": Learn more about the (ImplementationGuide) title FHIR attribute
Description: draft | active | retired | unknown
FHIR Version: r4
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: For testing purposes, not real usage
FHIR Version: r4
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: Date last changed
FHIR Version: r4
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 of the publisher (organization or individual)
FHIR Version: r4
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: Contact details for the publisher
FHIR Version: r4
Attribute Type : ContactDetail
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"contact": [
{
"name": "ONC",
"telecom": [
{
"system": "url",
"value": "http://www.healthit.gov"
}
]
},
{
"name": "HL7",
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
}
]
}
]Learn more about the (ImplementationGuide) contact FHIR attribute
Description: Natural language description of the implementation guide
FHIR Version: r4
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
Description: The context that the content is intended to support
FHIR Version: r4
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: Intended jurisdiction for implementation guide (if applicable)
FHIR Version: r4
Attribute Type : CodeableConcept
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"jurisdiction": [
{
"coding": [
{
"system": "urn:iso:std:iso:3166",
"code": "US"
}
]
}
]Learn more about the (ImplementationGuide) jurisdiction FHIR attribute
Description: Use and/or publishing restrictions
FHIR Version: r4
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: NPM Package name for IG
FHIR Version: r4
Attribute Type : id
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"packageId": "hl7.fhir.us.daf"Learn more about the (ImplementationGuide) packageId FHIR attribute
Description: SPDX license code for this IG (or not-open-source)
FHIR Version: r4
Attribute Type : code
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"license": "CC0-1.0"Learn more about the (ImplementationGuide) license FHIR attribute
Description: FHIR Version(s) this Implementation Guide targets
FHIR Version: r4
Attribute Type : code
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"fhirVersion": [
"4.0.1"
]Learn more about the (ImplementationGuide) fhirVersion FHIR attribute
Description: Another Implementation guide this depends on
FHIR Version: r4
Attribute Type : Data Type
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"dependsOn": [
{
"uri": "http://hl7.org/fhir/ImplementationGuide/uscore"
}
]Learn more about the (ImplementationGuide) dependsOn FHIR attribute
Description: Profiles that apply globally
FHIR Version: r4
Attribute Type : Data Type
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"global": [
{
"type": "Patient",
"profile": "http://hl7.org/fhir/us/core/StructureDefinition/patient"
}
]Learn more about the (ImplementationGuide) global FHIR attribute
Description: Information needed to build the IG
FHIR Version: r4
Attribute Type : Data Type
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"definition": {
"grouping": [
{
"name": "test",
"description": "Base package (not broken up into multiple packages)"
}
],
"resource": [
{
"reference": {
"reference": "Patient/test"
},
"name": "Test Example",
"description": "A test example to show how an implementation guide works",
"exampleCanonical": "http://hl7.org/fhir/us/core/StructureDefinition/patient"
}
],
"page": {
"nameUrl": "patient-example.html",
"title": "Example Patient Page",
"generation": "html",
"page": [
{
"nameUrl": "list.html",
"title": "Value Set Page",
"generation": "html"
}
]
},
"parameter": [
{
"code": "apply",
"value": "version"
}
]
}Learn more about the (ImplementationGuide) definition FHIR attribute
Description: Information about an assembled IG
FHIR Version: r4
Attribute Type : Data Type
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"manifest": {
"rendering": "http://hl7.org/fhir/us/daf",
"resource": [
{
"reference": {
"reference": "Patient/test"
},
"exampleCanonical": "http://hl7.org/fhir/us/core/StructureDefinition/patient",
"relativePath": "patient-test.html#patient-test"
}
],
"page": [
{
"name": "patient-test.html",
"title": "Test Patient Example",
"anchor": [
"patient-test",
"tx",
"uml"
]
}
],
"image": [
"fhir.png"
],
"other": [
"fhir.css"
]
}Learn more about the (ImplementationGuide) manifest FHIR attribute
ImplementationGuide Example
{
"resourceType": "ImplementationGuide",
"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/us/daf</b></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 of America <span>(Details : {urn:iso:std:iso:3166 code 'US' = 'United States of America)</span></p><p><b>copyright</b>: Published by ONC under the standard FHIR license (CC0)</p><p><b>packageId</b>: hl7.fhir.us.daf</p><p><b>license</b>: CC0-1.0</p><p><b>fhirVersion</b>: 4.0.1</p><h3>DependsOns</h3><table><tr><td>-</td><td><b>Uri</b></td></tr><tr><td>*</td><td><a>http://hl7.org/fhir/ImplementationGuide/uscore</a></td></tr></table><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>http://hl7.org/fhir/us/core/StructureDefinition/patient</a></td></tr></table><blockquote><p><b>definition</b></p><h3>Groupings</h3><table><tr><td>-</td><td><b>Name</b></td><td><b>Description</b></td></tr><tr><td>*</td><td>test</td><td>Base package (not broken up into multiple packages)</td></tr></table><h3>Resources</h3><table><tr><td>-</td><td><b>Reference</b></td><td><b>Name</b></td><td><b>Description</b></td><td><b>Example[x]</b></td></tr><tr><td>*</td><td><a>Patient/test</a></td><td>Test Example</td><td>A test example to show how an implementation guide works</td><td><a>http://hl7.org/fhir/us/core/StructureDefinition/patient</a></td></tr></table><blockquote><p><b>page</b></p><p><b>name</b>: <a>patient-example.html</a></p><p><b>title</b>: Example Patient Page</p><p><b>generation</b>: html</p><h3>Pages</h3><table><tr><td>-</td></tr><tr><td>*</td></tr></table></blockquote><h3>Parameters</h3><table><tr><td>-</td><td><b>Code</b></td><td><b>Value</b></td></tr><tr><td>*</td><td>apply</td><td>version</td></tr></table></blockquote><blockquote><p><b>manifest</b></p><p><b>rendering</b>: <a>http://hl7.org/fhir/us/daf</a></p><h3>Resources</h3><table><tr><td>-</td><td><b>Reference</b></td><td><b>Example[x]</b></td><td><b>RelativePath</b></td></tr><tr><td>*</td><td><a>Patient/test</a></td><td><a>http://hl7.org/fhir/us/core/StructureDefinition/patient</a></td><td><a>patient-test.html#patient-test</a></td></tr></table><h3>Pages</h3><table><tr><td>-</td><td><b>Name</b></td><td><b>Title</b></td><td><b>Anchor</b></td></tr><tr><td>*</td><td>patient-test.html</td><td>Test Patient Example</td><td>patient-test</td></tr></table><p><b>image</b>: fhir.png</p><p><b>other</b>: fhir.css</p></blockquote></div>"
},
"url": "http://hl7.org/fhir/us/daf",
"version": "0",
"name": "Data Access Framework (DAF)",
"status": "draft",
"experimental": false,
"date": "2015-01-01",
"publisher": "ONC / HL7 Joint project",
"contact": [
{
"name": "ONC",
"telecom": [
{
"system": "url",
"value": "http://www.healthit.gov"
}
]
},
{
"name": "HL7",
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
}
]
}
],
"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",
"jurisdiction": [
{
"coding": [
{
"system": "urn:iso:std:iso:3166",
"code": "US"
}
]
}
],
"copyright": "Published by ONC under the standard FHIR license (CC0)",
"packageId": "hl7.fhir.us.daf",
"license": "CC0-1.0",
"fhirVersion": [
"4.0.1"
],
"dependsOn": [
{
"uri": "http://hl7.org/fhir/ImplementationGuide/uscore"
}
],
"global": [
{
"type": "Patient",
"profile": "http://hl7.org/fhir/us/core/StructureDefinition/patient"
}
],
"definition": {
"grouping": [
{
"name": "test",
"description": "Base package (not broken up into multiple packages)"
}
],
"resource": [
{
"reference": {
"reference": "Patient/test"
},
"name": "Test Example",
"description": "A test example to show how an implementation guide works",
"exampleCanonical": "http://hl7.org/fhir/us/core/StructureDefinition/patient"
}
],
"page": {
"nameUrl": "patient-example.html",
"title": "Example Patient Page",
"generation": "html",
"page": [
{
"nameUrl": "list.html",
"title": "Value Set Page",
"generation": "html"
}
]
},
"parameter": [
{
"code": "apply",
"value": "version"
}
]
},
"manifest": {
"rendering": "http://hl7.org/fhir/us/daf",
"resource": [
{
"reference": {
"reference": "Patient/test"
},
"exampleCanonical": "http://hl7.org/fhir/us/core/StructureDefinition/patient",
"relativePath": "patient-test.html#patient-test"
}
],
"page": [
{
"name": "patient-test.html",
"title": "Test Patient Example",
"anchor": [
"patient-test",
"tx",
"uml"
]
}
],
"image": [
"fhir.png"
],
"other": [
"fhir.css"
]
}
}ImplementationGuide Structure
{
"resourceType" : "ImplementationGuide",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"url" : "<uri>", // R! Canonical identifier for this implementation guide, represented as a URI (globally unique)
"version" : "<string>", // Business version of the implementation guide
"name" : "<string>", // C? R! Name for this implementation guide (computer friendly)
"title" : "<string>", // Name for this implementation guide (human friendly)
"status" : "<code>", // R! draft | active | retired | unknown
"experimental" : <boolean>, // For testing purposes, not real usage
"date" : "<dateTime>", // Date 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 }], // The context that the content is intended to support
"jurisdiction" : [{ CodeableConcept }], // Intended jurisdiction for implementation guide (if applicable)
"copyright" : "<markdown>", // Use and/or publishing restrictions
"packageId" : "<id>", // R! NPM Package name for IG
"license" : "<code>", // SPDX license code for this IG (or not-open-source)
"fhirVersion" : ["<code>"], // R! FHIR Version(s) this Implementation Guide targets
"dependsOn" : [{ // Another Implementation guide this depends on
"uri" : { canonical(ImplementationGuide) }, // R! Identity of the IG that this depends on
"packageId" : "<id>", // NPM Package name for IG this depends on
"version" : "<string>" // Version of the IG
}],
"global" : [{ // Profiles that apply globally
"type" : "<code>", // R! Type this profile applies to
"profile" : { canonical(StructureDefinition) } // R! Profile that all resources must conform to
}],
"definition" : { // Information needed to build the IG
"grouping" : [{ // Grouping used to present related resources in the IG
"name" : "<string>", // R! Descriptive name for the package
"description" : "<string>" // Human readable text describing the package
}],
"resource" : [{ // R! Resource in the implementation guide
"reference" : { Reference(Any) }, // R! Location of the resource
"fhirVersion" : ["<code>"], // Versions this applies to (if different to IG)
"name" : "<string>", // Human Name for the resource
"description" : "<string>", // Reason why included in guide
// example[x]: Is an example/What is this an example of?. One of these 2:
"exampleBoolean" : <boolean>,
"exampleCanonical" : { canonical(StructureDefinition) },
"groupingId" : "<id>" // Grouping this is part of
}],
"page" : { // Page/Section in the Guide
// name[x]: Where to find that page. One of these 2:
"nameUrl" : "<url>",
"nameReference" : { Reference(Binary) },
"title" : "<string>", // R! Short title shown for navigational assistance
"generation" : "<code>", // R! html | markdown | xml | generated
"page" : [{ Content as for ImplementationGuide.definition.page }] // Nested Pages / Sections
},
"parameter" : [{ // Defines how IG is built by tools
"code" : "<code>", // R! apply | path-resource | path-pages | path-tx-cache | expansion-parameter | rule-broken-links | generate-xml | generate-json | generate-turtle | html-template
"value" : "<string>" // R! Value for named type
}],
"template" : [{ // A template for building resources
"code" : "<code>", // R! Type of template specified
"source" : "<string>", // R! The source location for the template
"scope" : "<string>" // The scope in which the template applies
}]
},
"manifest" : { // Information about an assembled IG
"rendering" : "<url>", // Location of rendered implementation guide
"resource" : [{ // R! Resource in the implementation guide
"reference" : { Reference(Any) }, // R! Location of the resource
// example[x]: Is an example/What is this an example of?. One of these 2:
"exampleBoolean" : <boolean>,
"exampleCanonical" : { canonical(StructureDefinition) },
"relativePath" : "<url>" // Relative path for page in IG
}],
"page" : [{ // HTML page within the parent IG
"name" : "<string>", // R! HTML page name
"title" : "<string>", // Title of the page, for references
"anchor" : ["<string>"] // Anchor available on the page
}],
"image" : ["<string>"], // Image within the IG
"other" : ["<string>"] // Additional linkable file in IG
}
}
ImplementationGuide Search Parameters
The following search parameters can be used to query ImplementationGuide resources. Just submit them like so:
https://api.1up.health/fhir/r4/ImplementationGuide?query-param=queryvalue| Search Parameter | Field Type | Resource Fields Searched |
|---|---|---|
context | text | useContext.value |
context-quantity | quantity | useContext.value |
context-type | text | useContext.code |
context-type-quantity | composite | useContext |
context-type-value | composite | useContext |
date | date | date |
depends-on | reference | dependsOn.uri |
description | text | description |
experimental | text | experimental |
global | reference | global.profile |
jurisdiction | text | jurisdiction |
name | text | name |
publisher | text | publisher |
resource | reference | definition.resource.reference |
status | text | status |
title | text | title |
url | uri | url |
version | text | version |
