description: 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.
package_name: hl7.fhir.r5.core
derivation: specialization
name: ImplementationGuide
type: ImplementationGuide
elements:
  description: {short: Natural language description of the implementation guide, type: markdown, index: 9}
  definition:
    constraint:
      ig-1: {human: 'If a resource has a groupingId, it must refer to a grouping defined in the Implementation Guide', severity: error, expression: resource.groupingId.all(%context.grouping.id contains $this)}
    short: Information needed to build the IG
    type: BackboneElement
    index: 23
    elements:
      grouping:
        type: BackboneElement
        short: Grouping used to present related resources in the IG
        array: true
        index: 24
        elements:
          name: {type: string, short: Descriptive name for the package, index: 25}
          description: {type: string, short: Human readable text describing the package, index: 26}
        required: [name]
      resource:
        type: BackboneElement
        short: Resource in the implementation guide
        array: true
        min: 1
        index: 27
        elements:
          reference:
            short: Location of the resource
            refers: ['http://hl7.org/fhir/StructureDefinition/Resource']
            type: Reference
            index: 28
          fhirVersion:
            short: Versions this applies to (if different to IG)
            type: code
            array: true
            binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/FHIR-version|4.2.0'}
            index: 29
          name: {type: string, short: Human Name for the resource, index: 30}
          description: {type: string, short: Reason why included in guide, index: 31}
          example:
            short: Is an example/What is this an example of?
            choices: [exampleBoolean, exampleCanonical]
            index: 33
          exampleBoolean: {short: 'Is an example/What is this an example of?', type: boolean, choiceOf: example, index: 34}
          exampleCanonical: {short: 'Is an example/What is this an example of?', type: canonical, choiceOf: example, index: 35}
          groupingId: {type: id, short: Grouping this is part of, index: 36}
        required: [reference]
      page:
        type: BackboneElement
        short: Page/Section in the Guide
        index: 37
        elements:
          name:
            short: Where to find that page
            choices: [nameUrl, nameReference]
            index: 39
          nameUrl: {short: Where to find that page, type: url, choiceOf: name, index: 40}
          nameReference:
            short: Where to find that page
            refers: ['http://hl7.org/fhir/StructureDefinition/Binary']
            type: Reference
            choiceOf: name
            index: 41
          title: {type: string, short: Short title shown for navigational assistance, index: 42}
          generation:
            type: code
            short: html | markdown | xml | generated
            binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/guide-page-generation|4.2.0'}
            index: 43
          page:
            short: Nested Pages / Sections
            elementReference: ['http://hl7.org/fhir/StructureDefinition/ImplementationGuide', elements, definition, elements, page]
            array: true
            index: 44
        required: [nameReference, generation, name, title, nameUrl]
      parameter:
        type: BackboneElement
        short: Defines how IG is built by tools
        array: true
        index: 45
        elements:
          code: {type: string, short: Code that identifies parameter, index: 46}
          value: {type: string, short: Value for named type, index: 47}
        required: [value, code]
      template:
        type: BackboneElement
        short: A template for building resources
        array: true
        index: 48
        elements:
          code: {type: code, short: Type of template specified, index: 49}
          source: {type: string, short: The source location for the template, index: 50}
          scope: {type: string, short: The scope in which the template applies, index: 51}
        required: [source, code]
    required: [resource]
  date: {short: Date last changed, type: dateTime, isSummary: true, index: 6}
  publisher: {short: Name of the publisher (organization or individual), type: string, isSummary: true, index: 7}
  fhirVersion:
    min: 1
    short: FHIR Version(s) this Implementation Guide targets
    type: code
    array: true
    binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/FHIR-version|4.2.0'}
    isSummary: true
    index: 15
  license:
    short: SPDX license code for this IG (or not-open-source)
    type: code
    binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/spdx-license|4.2.0'}
    isSummary: true
    index: 14
  jurisdiction:
    short: Intended jurisdiction for implementation guide (if applicable)
    type: CodeableConcept
    array: true
    binding: {strength: extensible, valueSet: 'http://hl7.org/fhir/ValueSet/jurisdiction'}
    isSummary: true
    index: 11
  global:
    short: Profiles that apply globally
    type: BackboneElement
    array: true
    isSummary: true
    index: 20
    elements:
      type:
        short: Type this profile applies to
        type: code
        binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/resource-types|4.2.0'}
        isSummary: true
        index: 21
      profile: {type: canonical, short: Profile that all resources must conform to, isSummary: true, index: 22}
    required: [profile, type]
  dependsOn:
    type: BackboneElement
    short: Another Implementation guide this depends on
    isSummary: true
    array: true
    index: 16
    elements:
      uri: {short: Identity of the IG that this depends on, type: canonical, isSummary: true, index: 17}
      packageId: {type: id, short: NPM Package name for IG this depends on, isSummary: true, index: 18}
      version: {short: Version of the IG, type: string, isSummary: true, index: 19}
    required: [uri]
  name: {short: Name for this implementation guide (computer friendly), type: string, isSummary: true, index: 2}
  useContext: {short: The context that the content is intended to support, type: UsageContext, array: true, isSummary: true, index: 10}
  copyright: {short: Use and/or publishing restrictions, type: markdown, index: 12}
  experimental: {short: 'For testing purposes, not real usage', type: boolean, isSummary: true, index: 5}
  manifest:
    type: BackboneElement
    short: Information about an assembled IG
    index: 52
    elements:
      rendering: {type: url, short: Location of rendered implementation guide, isSummary: true, index: 53}
      resource:
        min: 1
        short: Resource in the implementation guide
        index: 54
        type: BackboneElement
        array: true
        elements:
          reference:
            short: Location of the resource
            refers: ['http://hl7.org/fhir/StructureDefinition/Resource']
            type: Reference
            isSummary: true
            index: 55
          example:
            short: Is an example/What is this an example of?
            choices: [exampleBoolean, exampleCanonical]
            index: 57
          exampleBoolean: {short: 'Is an example/What is this an example of?', type: boolean, choiceOf: example, index: 58}
          exampleCanonical: {short: 'Is an example/What is this an example of?', type: canonical, choiceOf: example, index: 59}
          relativePath: {type: url, short: Relative path for page in IG, index: 60}
        required: [reference]
        isSummary: true
      page:
        short: HTML page within the parent IG
        type: BackboneElement
        array: true
        index: 61
        elements:
          name: {type: string, short: HTML page name, index: 62}
          title: {type: string, short: 'Title of the page, for references', index: 63}
          anchor: {short: Anchor available on the page, type: string, array: true, index: 64}
        required: [name]
      image: {type: string, short: Image within the IG, array: true, index: 65}
      other: {type: string, short: Additional linkable file in IG, array: true, index: 66}
    required: [resource]
  title: {short: Name for this implementation guide (human friendly), type: string, isSummary: true, index: 3}
  status:
    isModifier: true
    short: draft | active | retired | unknown
    type: code
    binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/publication-status|4.2.0'}
    isModifierReason: This is labeled as "Is Modifier" because applications should not use a retired {{title}} without due consideration
    isSummary: true
    index: 4
  url: {short: 'Canonical identifier for this implementation guide, represented as a URI (globally unique)', type: uri, isSummary: true, index: 0}
  version: {short: Business version of the implementation guide, type: string, isSummary: true, index: 1}
  packageId: {short: NPM Package name for IG, type: id, isSummary: true, index: 13}
  contact: {short: Contact details for the publisher, type: ContactDetail, array: true, isSummary: true, index: 8}
package_version: 4.2.0
class: resource
kind: resource
url: http://hl7.org/fhir/StructureDefinition/ImplementationGuide
base: http://hl7.org/fhir/StructureDefinition/CanonicalResource
version: 4.2.0
required: [url, name, status, packageId, fhirVersion]