PackagesCanonicalsLogsProblems
    Packages
    hl7.fhir.r6.core@6.0.0-ballot4
    http://hl7.org/fhir/StructureDefinition/ImplementationGuide
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.r6.core
derivation: specialization
name: ImplementationGuide
type: ImplementationGuide
elements:
  description: {isModifier: false, short: Natural language description of the implementation guide, type: markdown, mustSupport: false, isSummary: false, index: 14}
  definition:
    constraint:
      ig-1: {human: 'If a resource has a groupingId, it must refer to a grouping defined in the Implementation Guide', source: 'http://hl7.org/fhir/StructureDefinition/ImplementationGuide', severity: error, expression: resource.groupingId.all(%context.grouping.id contains $this)}
    isModifier: false
    short: Information needed to build the IG
    type: BackboneElement
    mustSupport: false
    isSummary: false
    index: 31
    elements:
      grouping:
        isModifier: false
        short: Grouping used to present related resources in the IG
        index: 32
        type: BackboneElement
        mustSupport: false
        array: true
        elements:
          name: {isModifier: false, short: Descriptive name for the package, type: string, mustSupport: false, isSummary: false, index: 33}
          description: {isModifier: false, short: Human readable text describing the package, type: markdown, mustSupport: false, isSummary: false, index: 34}
        required: [name]
        isSummary: false
      resource:
        isModifier: false
        short: Resource in the implementation guide
        index: 35
        type: BackboneElement
        mustSupport: false
        array: true
        elements:
          reference:
            isModifier: false
            short: Location of the resource
            refers: ['http://hl7.org/fhir/StructureDefinition/Resource']
            type: Reference
            mustSupport: false
            isSummary: false
            index: 36
          fhirVersion:
            isModifier: false
            short: Versions this applies to (if different to IG)
            type: code
            mustSupport: false
            array: true
            binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/FHIR-version|6.0.0-ballot4'}
            isSummary: false
            index: 37
          name: {isModifier: false, short: Human readable name for the resource, type: string, mustSupport: false, isSummary: false, index: 38}
          description: {isModifier: false, short: Reason why included in guide, type: markdown, mustSupport: false, isSummary: false, index: 39}
          isExample: {isModifier: false, short: Is this an example, type: boolean, mustSupport: false, isSummary: false, index: 40}
          profile: {isModifier: false, short: Profile(s) this resource is valid against, type: canonical, mustSupport: false, array: true, isSummary: false, index: 41}
          groupingId: {isModifier: false, short: Grouping this is part of, type: id, mustSupport: false, isSummary: false, index: 42}
        required: [reference]
        isSummary: false
      page:
        constraint:
          ig-3: {human: Source must be absent if 'generated' is generated, source: 'http://hl7.org/fhir/StructureDefinition/ImplementationGuide', severity: error, expression: generation='generated' implies source.empty()}
        isModifier: false
        short: Page/Section in the Guide
        index: 43
        type: BackboneElement
        mustSupport: false
        elements:
          source:
            isModifier: false
            short: Source for page
            mustSupport: false
            choices: [sourceUrl, sourceString, sourceMarkdown]
            isSummary: false
            index: 45
          sourceUrl: {isModifier: false, short: Source for page, type: url, mustSupport: false, choiceOf: source, isSummary: false, index: 46}
          sourceString: {isModifier: false, short: Source for page, type: string, mustSupport: false, choiceOf: source, isSummary: false, index: 47}
          sourceMarkdown: {isModifier: false, short: Source for page, type: markdown, mustSupport: false, choiceOf: source, isSummary: false, index: 48}
          name: {isModifier: false, short: Name of the page when published, type: url, mustSupport: false, isSummary: false, index: 49}
          title: {isModifier: false, short: Short title shown for navigational assistance, type: string, mustSupport: false, isSummary: false, index: 50}
          generation:
            isModifier: false
            short: html | markdown | xml | generated
            type: code
            mustSupport: false
            binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/guide-page-generation|6.0.0-ballot4'}
            isSummary: false
            index: 51
          page:
            elementReference: ['http://hl7.org/fhir/StructureDefinition/ImplementationGuide', elements, definition, elements, page]
            isModifier: false
            short: Nested Pages / Sections
            mustSupport: false
            array: true
            isSummary: false
            index: 52
        required: [generation, name, title]
        isSummary: false
      parameter:
        isModifier: false
        short: Defines how IG is built by tools
        index: 53
        type: BackboneElement
        mustSupport: false
        array: true
        elements:
          code:
            isModifier: false
            short: Code that identifies parameter
            type: Coding
            mustSupport: false
            binding: {strength: extensible, valueSet: 'http://hl7.org/fhir/ValueSet/guide-parameter-code'}
            isSummary: false
            index: 54
          value: {isModifier: false, short: Value for named type, type: string, mustSupport: false, isSummary: false, index: 55}
        required: [value, code]
        isSummary: false
      template:
        isModifier: false
        short: A template for building resources
        index: 56
        type: BackboneElement
        mustSupport: false
        array: true
        elements:
          code: {isModifier: false, short: Type of template specified, type: code, mustSupport: false, isSummary: false, index: 57}
          source: {isModifier: false, short: The source location for the template, type: string, mustSupport: false, isSummary: false, index: 58}
          scope: {isModifier: false, short: The scope in which the template applies, type: string, mustSupport: false, isSummary: false, index: 59}
        required: [source, code]
        isSummary: false
  date: {isModifier: false, short: Date last changed, type: dateTime, mustSupport: false, isSummary: true, index: 11}
  publisher: {isModifier: false, short: Name of the publisher/steward (organization or individual), type: string, mustSupport: false, isSummary: true, index: 12}
  fhirVersion:
    min: 1
    isModifier: false
    short: FHIR Version(s) this Implementation Guide targets
    index: 22
    type: code
    mustSupport: false
    array: true
    binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/FHIR-version|6.0.0-ballot4'}
    isSummary: true
  license:
    isModifier: false
    short: SPDX license code for this IG (or not-open-source)
    type: code
    mustSupport: false
    binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/spdx-license|6.0.0-ballot4'}
    isSummary: true
    index: 21
  jurisdiction:
    isModifier: false
    short: Jurisdiction of the authority that maintains the implementation guide (if applicable)
    type: CodeableConcept
    mustSupport: false
    array: true
    binding: {strength: extensible, valueSet: 'http://terminology.hl7.org/ValueSet/jurisdiction'}
    isSummary: true
    index: 16
  global:
    isModifier: false
    short: Profiles that apply globally
    index: 28
    type: BackboneElement
    mustSupport: false
    array: true
    elements:
      type:
        isModifier: false
        short: Type this profile applies to
        type: code
        mustSupport: false
        binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/resource-types|6.0.0-ballot4'}
        isSummary: true
        index: 29
      profile: {isModifier: false, short: Profile that all resources must conform to, type: canonical, mustSupport: false, isSummary: true, index: 30}
    required: [profile, type]
    isSummary: true
  purpose: {isModifier: false, short: Why this implementation guide is defined, type: markdown, mustSupport: false, isSummary: false, index: 17}
  dependsOn:
    isModifier: false
    short: Another Implementation guide this depends on
    index: 23
    type: BackboneElement
    mustSupport: false
    array: true
    elements:
      uri: {isModifier: false, short: Identity of the IG that this depends on, type: canonical, mustSupport: false, isSummary: true, index: 24}
      packageId: {isModifier: false, short: NPM Package name for IG this depends on, type: id, mustSupport: false, isSummary: true, index: 25}
      version: {isModifier: false, short: Version of the IG, type: string, mustSupport: false, isSummary: true, index: 26}
      reason: {isModifier: false, short: Why dependency exists, type: markdown, mustSupport: false, isSummary: false, index: 27}
    required: [uri]
    isSummary: true
  name: {isModifier: false, short: Name for this implementation guide (computer friendly), type: string, mustSupport: false, isSummary: true, index: 7}
  copyrightLabel: {isModifier: false, short: Copyright holder and year(s), type: string, mustSupport: false, isSummary: false, index: 19}
  useContext: {isModifier: false, short: The context that the content is intended to support, type: UsageContext, mustSupport: false, array: true, isSummary: true, index: 15}
  copyright: {isModifier: false, short: 'Notice about intellectual property ownership, can include restrictions on use', type: markdown, mustSupport: false, isSummary: false, index: 18}
  versionAlgorithm:
    isModifier: false
    short: How to compare versions
    mustSupport: false
    choices: [versionAlgorithmString, versionAlgorithmCoding]
    isSummary: true
    index: 4
  experimental: {isModifier: false, short: For testing only - never for real usage, type: boolean, mustSupport: false, meaningWhenMissing: 'If absent, this resource is treated as though it is not experimental.', isSummary: true, index: 10}
  manifest:
    isModifier: false
    short: Information about an assembled IG
    type: BackboneElement
    mustSupport: false
    isSummary: false
    index: 60
    elements:
      rendering: {isModifier: false, short: Location of rendered implementation guide, type: url, mustSupport: false, isSummary: true, index: 61}
      resource:
        min: 1
        isModifier: false
        short: Resource in the implementation guide
        index: 62
        type: BackboneElement
        mustSupport: false
        array: true
        elements:
          reference:
            isModifier: false
            short: Location of the resource
            refers: ['http://hl7.org/fhir/StructureDefinition/Resource']
            type: Reference
            mustSupport: false
            isSummary: true
            index: 63
          isExample: {isModifier: false, short: Is this an example, type: boolean, mustSupport: false, isSummary: false, index: 64}
          profile: {isModifier: false, short: Profile(s) this is an example of, type: canonical, mustSupport: false, array: true, isSummary: false, index: 65}
          relativePath: {isModifier: false, short: Relative path for page in IG, type: url, mustSupport: false, isSummary: false, index: 66}
        required: [reference]
        isSummary: true
      page:
        isModifier: false
        short: HTML page within the parent IG
        index: 67
        type: BackboneElement
        mustSupport: false
        array: true
        elements:
          name: {isModifier: false, short: HTML page name, type: string, mustSupport: false, isSummary: false, index: 68}
          title: {isModifier: false, short: 'Title of the page, for references', type: string, mustSupport: false, isSummary: false, index: 69}
          anchor: {isModifier: false, short: Anchor available on the page, type: string, mustSupport: false, array: true, isSummary: false, index: 70}
        required: [name]
        isSummary: false
      image: {isModifier: false, short: Image within the IG, type: string, mustSupport: false, array: true, isSummary: false, index: 71}
      other: {isModifier: false, short: Additional linkable file in IG, type: string, mustSupport: false, array: true, isSummary: false, index: 72}
    required: [resource]
  title: {isModifier: false, short: Name for this implementation guide (human friendly), type: string, mustSupport: false, isSummary: true, index: 8}
  versionAlgorithmCoding: {isModifier: false, short: How to compare versions, type: Coding, mustSupport: false, choiceOf: versionAlgorithm, isSummary: true, index: 6}
  status:
    isModifier: true
    short: draft | active | retired | unknown
    index: 9
    type: code
    mustSupport: false
    binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/publication-status|6.0.0-ballot4'}
    isModifierReason: This is labeled as "Is Modifier" because applications should not use a retired {{title}} without due consideration
    isSummary: true
  url:
    constraint:
      cnl-1: {human: 'URL should not contain | or # - these characters make processing canonical references problematic', source: 'http://hl7.org/fhir/StructureDefinition/ImplementationGuide', severity: warning, expression: 'exists() implies matches(''^[^|# ]+$'')'}
    isModifier: false
    short: Canonical identifier for this implementation guide, represented as a URI (globally unique)
    type: uri
    mustSupport: false
    isSummary: true
    index: 0
  identifier: {isModifier: false, short: Additional identifier for the implementation guide (business identifier), type: Identifier, mustSupport: false, array: true, isSummary: true, index: 1}
  versionAlgorithmString: {isModifier: false, short: How to compare versions, type: string, mustSupport: false, choiceOf: versionAlgorithm, isSummary: true, index: 5}
  version: {isModifier: false, short: Business version of the implementation guide, type: string, mustSupport: false, isSummary: true, index: 2}
  packageId: {isModifier: false, short: NPM Package name for IG, type: id, mustSupport: false, isSummary: true, index: 20}
  contact: {isModifier: false, short: Contact details for the publisher, type: ContactDetail, mustSupport: false, array: true, isSummary: true, index: 13}
package_version: 6.0.0-ballot4
class: resource
kind: resource
url: http://hl7.org/fhir/StructureDefinition/ImplementationGuide
base: http://hl7.org/fhir/StructureDefinition/DomainResource
version: 6.0.0-ballot4
required: [url, name, status, packageId, fhirVersion]