ImplementationGuide - FHIR Resource (dstu2)


This ImplementationGuide Resource uses the FHIR API standard for access and structure.

Validate an ImplementationGuide FHIR Resource (dstu2)



Resource Attributes

AttributeField is listTypeDescription
binarytrueuri# Image, css, script, etc.
contacttrueData Type# Contact details of the publisher
copyrightfalsestring# Use and/or publishing restrictions
datefalsedateTime# Date for this version of the Implementation Guide
dependencytrueData Type# Another Implementation guide this depends on
descriptionfalsestring# Natural language description of the Implementation Guide
experimentalfalseboolean# If for testing purposes, not real usage
fhirVersionfalseid# FHIR Version this Implementation Guide targets
globaltrueData Type# Profiles that apply globally
namefalsestring# Informal name for this Implementation Guide
packagetrueData Type# Group of resources as used in .page.package
pagefalseData Type# Page/Section in the Guide
publisherfalsestring# Name of the publisher (Organization or individual)
statusfalsecode# draft | active | retired
urlfalseuri# Absolute URL used to reference this Implementation Guide
useContexttrueCodeableConcept# The implementation guide is intended to support these contexts
versionfalsestring# Logical id for this version of the Implementation Guide

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 the like so:

https://api.1up.health/fhir/dstu2/ImplementationGuide?query-param=queryvalue
Search ParameterField TypeResource Fields Searched
contexttextuseContext
datedatedate
dependencyuridependency.uri
descriptiontextdescription
experimentaltextexperimental
nametextname
publishertextpublisher
statustextstatus
urluriurl
versiontextversion