ImplementationGuide - FHIR Resource (dstu2)
This ImplementationGuide Resource uses the FHIR API standard for access and structure.
Validate an ImplementationGuide FHIR Resource (dstu2)
ImplementationGuide Attributes
AttributeField is listTypeDescription
Description: draft | active | retired
FHIR Version: dstu2
Attribute Type : code
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"status": Learn more about the (ImplementationGuide) status FHIR attribute
Description: Name of the publisher (Organization or individual)
FHIR Version: dstu2
Attribute Type : string
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"publisher": Learn more about the (ImplementationGuide) publisher FHIR attribute
Description: Date for this version of the Implementation Guide
FHIR Version: dstu2
Attribute Type : dateTime
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"date": Learn more about the (ImplementationGuide) date FHIR attribute
Description: Informal name for this Implementation Guide
FHIR Version: dstu2
Attribute Type : string
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"name": Learn more about the (ImplementationGuide) name FHIR attribute
Description: Use and/or publishing restrictions
FHIR Version: dstu2
Attribute Type : string
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"copyright": Learn more about the (ImplementationGuide) copyright FHIR attribute
Description: Group of resources as used in .page.package
FHIR Version: dstu2
Attribute Type : Data Type
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"package": Learn more about the (ImplementationGuide) package FHIR attribute
Description: Absolute URL used to reference this Implementation Guide
FHIR Version: dstu2
Attribute Type : uri
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"url": Learn more about the (ImplementationGuide) url FHIR attribute
Description: Profiles that apply globally
FHIR Version: dstu2
Attribute Type : Data Type
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"global": Learn more about the (ImplementationGuide) global FHIR attribute
Description: Another Implementation guide this depends on
FHIR Version: dstu2
Attribute Type : Data Type
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"dependency": Learn more about the (ImplementationGuide) dependency FHIR attribute
Description: Contact details of the publisher
FHIR Version: dstu2
Attribute Type : Data Type
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"contact": Learn more about the (ImplementationGuide) contact FHIR attribute
Description: The implementation guide is intended to support these contexts
FHIR Version: dstu2
Attribute Type : CodeableConcept
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: Logical id for this version of the Implementation Guide
FHIR Version: dstu2
Attribute Type : string
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"version": Learn more about the (ImplementationGuide) version FHIR attribute
Description: FHIR Version this Implementation Guide targets
FHIR Version: dstu2
Attribute Type : id
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"fhirVersion": Learn more about the (ImplementationGuide) fhirVersion FHIR attribute
Description: Image, css, script, etc.
FHIR Version: dstu2
Attribute Type : uri
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"binary": Learn more about the (ImplementationGuide) binary FHIR attribute
Description: Page/Section in the Guide
FHIR Version: dstu2
Attribute Type : Data Type
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"page": Learn more about the (ImplementationGuide) page FHIR attribute
Description: If for testing purposes, not real usage
FHIR Version: dstu2
Attribute Type : boolean
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"experimental": Learn more about the (ImplementationGuide) experimental FHIR attribute
Description: Natural language description of the Implementation Guide
FHIR Version: dstu2
Attribute Type : string
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"description": Learn more about the (ImplementationGuide) description FHIR attribute
ImplementationGuide Structure
{
"resourceType" : "ImplementationGuide",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"url" : "<uri>", // R! Absolute URL used to reference this Implementation Guide
"version" : "<string>", // Logical id for this version of the Implementation Guide
"name" : "<string>", // R! Informal name for this Implementation Guide
"status" : "<code>", // R! draft | active | retired
"experimental" : <boolean>, // If for testing purposes, not real usage
"publisher" : "<string>", // Name of the publisher (Organization or individual)
"contact" : [{ // Contact details of the publisher
"name" : "<string>", // Name of a individual to contact
"telecom" : [{ ContactPoint }] // Contact details for individual or publisher
}],
"date" : "<dateTime>", // Date for this version of the Implementation Guide
"description" : "<string>", // Natural language description of the Implementation Guide
"useContext" : [{ CodeableConcept }], // The implementation guide is intended to support these contexts
"copyright" : "<string>", // 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" : [{ // R! 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
"purpose" : "<code>", // R! example | terminology | profile | extension | dictionary | logical
"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" : { // R! Page/Section in the Guide
"source" : "<uri>", // R! Where to find that page
"name" : "<string>", // R! Short name 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/dstu2/ImplementationGuide?query-param=queryvalue| Search Parameter | Field Type | Resource Fields Searched |
|---|---|---|
context | text | useContext |
date | date | date |
dependency | uri | dependency.uri |
description | text | description |
experimental | text | experimental |
name | text | name |
publisher | text | publisher |
status | text | status |
url | uri | url |
version | text | version |
