ImplementationGuide - FHIR Resource (r4)


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

Validate an ImplementationGuide FHIR Resource (r4)



Resource Attributes

AttributeField is listTypeDescription
contacttrueContactDetail# Contact details for the publisher
copyrightfalsemarkdown# Use and/or publishing restrictions
datefalsedateTime# Date last changed
definitionfalseData Type# Information needed to build the IG
dependsOntrueData Type# Another Implementation guide this depends on
descriptionfalsemarkdown# Natural language description of the implementation guide
experimentalfalseboolean# For testing purposes, not real usage
fhirVersiontruecode# FHIR Version(s) this Implementation Guide targets
globaltrueData Type# Profiles that apply globally
jurisdictiontrueCodeableConcept# Intended jurisdiction for implementation guide (if applicable)
licensefalsecode# SPDX license code for this IG (or not-open-source)
manifestfalseData Type# Information about an assembled IG
namefalsestring# C? Name for this implementation guide (computer friendly)
packageIdfalseid# NPM Package name for IG
publisherfalsestring# Name of the publisher (organization or individual)
statusfalsecode# draft | active | retired | unknown
titlefalsestring# Name for this implementation guide (human friendly)
urlfalseuri# Canonical identifier for this implementation guide, represented as a URI (globally unique)
useContexttrueUsageContext# The context that the content is intended to support
versionfalsestring# Business version of the implementation guide

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 ParameterField TypeResource Fields Searched
contexttextuseContext.value
context-quantityquantityuseContext.value
context-typetextuseContext.code
context-type-quantitycompositeuseContext
context-type-valuecompositeuseContext
datedatedate
depends-onreferencedependsOn.uri
descriptiontextdescription
experimentaltextexperimental
globalreferenceglobal.profile
jurisdictiontextjurisdiction
nametextname
publishertextpublisher
resourcereferencedefinition.resource.reference
statustextstatus
titletexttitle
urluriurl
versiontextversion