ImplementationGuide - FHIR Resource (stu3)


Resource Attributes

AttributeField is listTypeDescription
binarytrueuri Image, css, script, etc.
contacttrueContactDetail Contact details for the publisher
copyrightfalsemarkdown Use and/or publishing restrictions
datefalsedateTime Date this was last changed
dependencytrueData Type Another Implementation guide this depends on
descriptionfalsemarkdown Natural language description of the implementation guide
experimentalfalseboolean For testing purposes, not real usage
fhirVersionfalseid FHIR Version this Implementation Guide targets
globaltrueData Type Profiles that apply globally
jurisdictiontrueCodeableConcept Intended jurisdiction for implementation guide (if applicable)
namefalsestring Name for this implementation guide (computer friendly)
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 | unknown
urlfalseuri Logical URI to reference this implementation guide (globally unique)
useContexttrueUsageContext Context the content is intended to support
versionfalsestring Business version of the implementation guide

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

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