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