ImplementationGuide

A set of rules of how a particular interoperability or standards problem is solved - typically through the use of FHIR resources. This resource is used to gather all the parts of an implementation guide into a logical whole and to publish a computable definition of all the parts. If the element is present, it must have either a @value, an @id, or extensions

type ImplementationGuide implements Resource {
  url: Uri
  version: String
  name: String
  title: String
  status: String
  experimental: Boolean
  date: Date
  publisher: String
  contact: [ContactDetail]
  description: String
  useContext: [UsageContext]
  jurisdiction: [CodeableConcept]
  copyright: String
  packageId: String
  license: String
  fhirVersion: [String]
  dependsOn: [ImplementationGuideDependsOn]
  global: [ImplementationGuideGlobal]
  definition: ImplementationGuideDefinition
  manifest: ImplementationGuideManifest
  text: Narrative
  contained: [Resource]
  extension: [Extension]
  modifierExtension: [Extension]
  id: String
  meta: Meta
  implicitRules: Uri
  language: String
}

Fields

ImplementationGuide.url ● Uri scalar

An absolute URI that is used to identify this implementation guide when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this implementation guide is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the implementation guide is stored on different servers.

ImplementationGuide.version ● String scalar

The identifier that is used to identify this version of the implementation guide when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the implementation guide author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.

ImplementationGuide.name ● String scalar

A natural language name identifying the implementation guide. This name should be usable as an identifier for the module by machine processing applications such as code generation.

ImplementationGuide.title ● String scalar

A short, descriptive, user-friendly title for the implementation guide.

ImplementationGuide.status ● String scalar

The status of this implementation guide. Enables tracking the life-cycle of the content.

ImplementationGuide.experimental ● Boolean scalar

A Boolean value to indicate that this implementation guide is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.

ImplementationGuide.date ● Date scalar

The date (and optionally time) when the implementation guide was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the implementation guide changes.

ImplementationGuide.publisher ● String scalar

The name of the organization or individual that published the implementation guide.

ImplementationGuide.contact ● [ContactDetail] list object

Contact details to assist a user in finding and communicating with the publisher.

ImplementationGuide.description ● String scalar

A free text natural language description of the implementation guide from a consumer s perspective.

ImplementationGuide.useContext ● [UsageContext] list object

The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate implementation guide instances.

ImplementationGuide.jurisdiction ● [CodeableConcept] list object

A legal or geographic region in which the implementation guide is intended to be used.

ImplementationGuide.copyright ● String scalar

A copyright statement relating to the implementation guide and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the implementation guide.

ImplementationGuide.packageId ● String scalar

The NPM package name for this Implementation Guide, used in the NPM package distribution, which is the primary mechanism by which FHIR based tooling manages IG dependencies. This value must be globally unique, and should be assigned with care.

ImplementationGuide.license ● String scalar

The license that applies to this Implementation Guide, using an SPDX license code, or not-open-source .

ImplementationGuide.fhirVersion ● [String] list scalar

The version(s) of the FHIR specification that this ImplementationGuide targets - e.g. describes how to use. The value of this element is the formal version of the specification, without the revision number, e.g. [publication].[major].[minor], which is 4.3.0 for this version.

ImplementationGuide.dependsOn ● [ImplementationGuideDependsOn] list object

Another implementation guide that this implementation depends on. Typically, an implementation guide uses value sets, profiles etc.defined in other implementation guides.

ImplementationGuide.global ● [ImplementationGuideGlobal] list object

A set of profiles that all resources covered by this implementation guide must conform to.

ImplementationGuide.definition ● ImplementationGuideDefinition object

The information needed by an IG publisher tool to publish the whole implementation guide.

ImplementationGuide.manifest ● ImplementationGuideManifest object

Information about an assembled implementation guide, created by the publication tooling.

ImplementationGuide.text ● Narrative object

A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it clinically safe for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

ImplementationGuide.contained ● [Resource] list interface

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

ImplementationGuide.extension ● [Extension] list object

May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ImplementationGuide.modifierExtension ● [Extension] list object

May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ImplementationGuide.id ● String scalar

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

ImplementationGuide.meta ● Meta object

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

ImplementationGuide.implicitRules ● Uri scalar

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

ImplementationGuide.language ● String scalar

The base language in which the resource is written.

Interfaces

Resource interface

This is the base resource type for everything.

Returned By

ImplementationGuide query ● ImplementationGuideCreate mutation ● ImplementationGuideList query ● ImplementationGuideUpdate mutation