description: Base StructureDefinition for ImplementationGuide Resource
package_name: hl7.fhir.r2b.core
derivation: specialization
name: ImplementationGuide
type: null
elements:
  description:
    isModifier: false
    short: Natural language description of the Implementation Guide
    index: 10
    comments: This field can be used for things such as why the Implementation Guide was written, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc.  It is *not* a rendering of the Implementation Guide as conveyed in Implementation Guide.text. This item SHOULD be populated unless the information is available from context.
    type: string
    mustSupport: false
    maxLength: 0
    base: {max: '1', min: 0, path: ImplementationGuide.description}
    isSummary: true
  binary:
    isModifier: false
    short: Image, css, script, etc.
    index: 33
    comments: This is principally included for the FHIR publishing tool, but may be useful when extracting and reusing content from the implementation guide.
    type: uri
    mustSupport: false
    array: true
    maxLength: 0
    base: {max: '*', min: 0, path: ImplementationGuide.binary}
    isSummary: false
  package:
    min: 1
    isModifier: false
    short: Group of resources as used in .page.package
    index: 17
    type: BackboneElement
    mustSupport: false
    array: true
    elements:
      name:
        isModifier: false
        short: Name used .page.package
        index: 18
        type: string
        mustSupport: false
        maxLength: 0
        base: {max: '1', min: 0, path: ImplementationGuide.package.name}
        isSummary: true
      description:
        isModifier: false
        short: Human readable text describing the package
        type: string
        mustSupport: false
        maxLength: 0
        base: {max: '1', min: 0, path: ImplementationGuide.package.description}
        isSummary: false
        index: 19
      resource:
        min: 1
        isModifier: false
        short: Resource in the implementation guide
        index: 20
        type: BackboneElement
        mustSupport: false
        array: true
        elements:
          example:
            isModifier: false
            short: If not an example, has it's normal meaning
            index: 21
            comments: Typically, conformance resources and knowledge resources are directly part of the implementation guide, with their normal meaning, and patient linked resources are usually examples. However this is not always true.
            type: boolean
            mustSupport: false
            maxLength: 0
            base: {max: '1', min: 0, path: ImplementationGuide.package.resource.example}
            isSummary: true
          name:
            isModifier: false
            short: Human Name for the resource
            type: string
            mustSupport: false
            maxLength: 0
            base: {max: '1', min: 0, path: ImplementationGuide.package.resource.name}
            isSummary: true
            index: 22
          description:
            isModifier: false
            short: Reason why included in guide
            index: 23
            comments: This is mostly used with examples to explain why it is present (though they can have extensive comments in the examples).
            type: string
            mustSupport: false
            maxLength: 0
            base: {max: '1', min: 0, path: ImplementationGuide.package.resource.description}
            isSummary: false
          acronym:
            isModifier: false
            short: Short code to identify the resource
            index: 24
            comments: This is used when generating schematrons from profiles, for example, but has other uses. Publishing tooling may autogenerate this value, but a human assigned value is more useful. This value must be unique within an implementation guide (across included guides as well).
            type: string
            mustSupport: false
            maxLength: 0
            base: {max: '1', min: 0, path: ImplementationGuide.package.resource.acronym}
            isSummary: false
          source:
            isModifier: false
            short: Location of the resource
            index: 26
            comments: Usually this is a relative URL that locates the resource within the implementation guide. If you authoring an implementation guide, and will publish it using the FHIR publication tooling, use a URI that may point to a resource, or to one of various alternative representations (e.g. spreadsheet). The tooling will convert this when it publishes it.
            mustSupport: false
            choices: [sourceUri, sourceReference]
            maxLength: 0
            base: {max: '1', min: 0, path: 'ImplementationGuide.package.resource.source[x]'}
            isSummary: true
          sourceUri:
            isModifier: false
            short: Location of the resource
            index: 27
            comments: Usually this is a relative URL that locates the resource within the implementation guide. If you authoring an implementation guide, and will publish it using the FHIR publication tooling, use a URI that may point to a resource, or to one of various alternative representations (e.g. spreadsheet). The tooling will convert this when it publishes it.
            type: uri
            mustSupport: false
            maxLength: 0
            base: {max: '1', min: 0, path: 'ImplementationGuide.package.resource.source[x]'}
            choiceOf: source
            isSummary: true
          sourceReference:
            isModifier: false
            short: Location of the resource
            index: 28
            comments: Usually this is a relative URL that locates the resource within the implementation guide. If you authoring an implementation guide, and will publish it using the FHIR publication tooling, use a URI that may point to a resource, or to one of various alternative representations (e.g. spreadsheet). The tooling will convert this when it publishes it.
            type: Reference
            mustSupport: false
            maxLength: 0
            base: {max: '1', min: 0, path: 'ImplementationGuide.package.resource.source[x]'}
            choiceOf: source
            isSummary: true
          exampleFor:
            isModifier: false
            short: Resource this is an example of (if applicable)
            index: 29
            comments: 'Examples: * StructureDefinition -> Any * ValueSet -> expansion * OperationDefinition -> Parameters * Questionnaire -> QuestionnaireResponse.'
            type: Reference
            mustSupport: false
            maxLength: 0
            base: {max: '1', min: 0, path: ImplementationGuide.package.resource.exampleFor}
            isSummary: false
        maxLength: 0
        base: {max: '*', min: 0, path: ImplementationGuide.package.resource}
        required: [example, sourceReference, source, sourceUri]
        isSummary: true
    maxLength: 0
    base: {max: '*', min: 0, path: ImplementationGuide.package}
    required: [resource, name]
    isSummary: true
  date:
    isModifier: false
    short: Date for this version of the Implementation Guide
    index: 9
    comments: Additional specific dates may be added as extensions.
    type: dateTime
    mustSupport: false
    maxLength: 0
    base: {max: '1', min: 0, path: ImplementationGuide.date}
    isSummary: true
  dependency:
    isModifier: false
    short: Another Implementation guide this depends on
    index: 14
    type: BackboneElement
    mustSupport: false
    array: true
    elements:
      type:
        isModifier: false
        short: reference | inclusion
        index: 15
        comments: For information about processing included guides, see [Including Guides]{implementationguide.html#include}.
        type: code
        mustSupport: false
        maxLength: 0
        base: {max: '1', min: 0, path: ImplementationGuide.dependency.type}
        isSummary: true
      uri:
        isModifier: false
        short: Where to find dependency
        index: 16
        comments: When a guide is published, and the type is 'include', this will be a relative reference within the guide.
        type: uri
        mustSupport: false
        maxLength: 0
        base: {max: '1', min: 0, path: ImplementationGuide.dependency.uri}
        isSummary: true
    maxLength: 0
    base: {max: '*', min: 0, path: ImplementationGuide.dependency}
    required: [uri, type]
    isSummary: true
  publisher:
    isModifier: false
    short: Name of the publisher (Organization or individual)
    index: 5
    comments: Usually an organization, but may be an individual. This item SHOULD be populated unless the information is available from context.
    type: string
    mustSupport: false
    maxLength: 0
    base: {max: '1', min: 0, path: ImplementationGuide.publisher}
    isSummary: true
  fhirVersion:
    isModifier: false
    short: FHIR Version this Implementation Guide targets
    index: 13
    comments: An Implementation Guide should specify the target it applies to, as ImplementationGuides are rarely valid across multiple versions of FHIR.
    type: id
    mustSupport: false
    maxLength: 0
    base: {max: '1', min: 0, path: ImplementationGuide.fhirVersion}
    isSummary: true
  global:
    isModifier: false
    short: Profiles that apply globally
    index: 30
    comments: See [Default Profiles](implementationguide.html#default) for a discussion of which resources are 'covered' by an implementation guide.
    type: BackboneElement
    mustSupport: false
    array: true
    elements:
      type:
        isModifier: false
        short: Type this profiles applies to
        index: 31
        comments: The type must match that of the profile that is referred to, but is made explicit here as a denormalization so that a system processing the implementation guide resource knows which resources the profile applies to even if the profile itself is not available.
        type: code
        mustSupport: false
        maxLength: 0
        base: {max: '1', min: 0, path: ImplementationGuide.global.type}
        isSummary: true
      profile:
        isModifier: false
        short: Profile that all resources must conform to
        index: 32
        type: Reference
        mustSupport: false
        maxLength: 0
        base: {max: '1', min: 0, path: ImplementationGuide.global.profile}
        isSummary: true
    maxLength: 0
    base: {max: '*', min: 0, path: ImplementationGuide.global}
    required: [profile, type]
    isSummary: true
  name:
    isModifier: false
    short: Informal name for this Implementation Guide
    index: 2
    comments: Not expected to be globally unique.
    type: string
    mustSupport: false
    maxLength: 0
    base: {max: '1', min: 0, path: ImplementationGuide.name}
    isSummary: true
  useContext:
    isModifier: false
    short: The implementation guide is intended to support these contexts
    index: 11
    type: CodeableConcept
    mustSupport: false
    array: true
    maxLength: 0
    base: {max: '*', min: 0, path: ImplementationGuide.useContext}
    isSummary: true
  copyright:
    isModifier: false
    short: Use and/or publishing restrictions
    type: string
    mustSupport: false
    maxLength: 0
    base: {max: '1', min: 0, path: ImplementationGuide.copyright}
    isSummary: false
    index: 12
  experimental:
    isModifier: false
    short: If for testing purposes, not real usage
    type: boolean
    mustSupport: false
    maxLength: 0
    base: {max: '1', min: 0, path: ImplementationGuide.experimental}
    isSummary: true
    index: 4
  page:
    isModifier: false
    short: Page/Section in the Guide
    index: 34
    comments: Pages automatically become sections if they have sub-pages. By convention, the home page is called index.html.
    type: BackboneElement
    mustSupport: false
    elements:
      source:
        isModifier: false
        short: Where to find that page
        index: 35
        comments: The publishing tool will autogenerate source for list (source = n/a), and inject included implementations for include (source = uri of guide to include).
        type: uri
        mustSupport: false
        maxLength: 0
        base: {max: '1', min: 0, path: ImplementationGuide.page.source}
        isSummary: true
      name:
        isModifier: false
        short: Short name shown for navigational assistance
        index: 36
        type: string
        mustSupport: false
        maxLength: 0
        base: {max: '1', min: 0, path: ImplementationGuide.page.name}
        isSummary: true
      kind:
        isModifier: false
        short: page | example | list | include | directory | dictionary | toc | resource
        index: 37
        type: code
        mustSupport: false
        maxLength: 0
        base: {max: '1', min: 0, path: ImplementationGuide.page.kind}
        isSummary: true
      type:
        isModifier: false
        short: Kind of resource to include in the list
        index: 38
        type: code
        mustSupport: false
        array: true
        maxLength: 0
        base: {max: '*', min: 0, path: ImplementationGuide.page.type}
        isSummary: false
      package:
        isModifier: false
        short: Name of package to include
        index: 39
        type: string
        mustSupport: false
        array: true
        maxLength: 0
        base: {max: '*', min: 0, path: ImplementationGuide.page.package}
        isSummary: false
      format:
        isModifier: false
        short: Format of the page (e.g. html, markdown, etc.)
        index: 40
        comments: This is primarily for the publishing tool, that will convert all pages to html format. HTML pages are pre-processed, see xxxx.
        type: code
        mustSupport: false
        maxLength: 0
        base: {max: '1', min: 0, path: ImplementationGuide.page.format}
        isSummary: false
      page:
        elementReference: ['http://hl7.org/fhir/StructureDefinition/ImplementationGuide']
        isModifier: false
        short: Nested Pages / Sections
        index: 41
        comments: The implementation guide breadcrumbs are generated from this structure.
        mustSupport: false
        array: true
        maxLength: 0
        base: {max: '*', min: 0, path: ImplementationGuide.page.page}
        isSummary: false
    maxLength: 0
    base: {max: '1', min: 0, path: ImplementationGuide.page}
    required: [name, kind, source]
    isSummary: true
  status:
    isModifier: true
    short: draft | active | retired
    index: 3
    type: code
    mustSupport: false
    maxLength: 0
    base: {max: '1', min: 0, path: ImplementationGuide.status}
    isSummary: true
  url:
    isModifier: false
    short: Absolute URL used to reference this Implementation Guide
    index: 0
    type: uri
    mustSupport: false
    maxLength: 0
    base: {max: '1', min: 0, path: ImplementationGuide.url}
    isSummary: true
  version:
    isModifier: false
    short: Logical id for this version of the Implementation Guide
    type: string
    mustSupport: false
    maxLength: 0
    base: {max: '1', min: 0, path: ImplementationGuide.version}
    isSummary: true
    index: 1
  contact:
    isModifier: false
    short: Contact details of the publisher
    index: 6
    comments: May be a web site, an email address, a telephone number (tel:), etc.
    type: BackboneElement
    mustSupport: false
    array: true
    elements:
      name:
        isModifier: false
        short: Name of an individual to contact
        index: 7
        comments: If there is no named individual, the telecom is for the organization as a whole.
        type: string
        mustSupport: false
        maxLength: 0
        base: {max: '1', min: 0, path: ImplementationGuide.contact.name}
        isSummary: true
      telecom:
        isModifier: false
        short: Contact details for individual or publisher
        index: 8
        type: ContactPoint
        mustSupport: false
        array: true
        maxLength: 0
        base: {max: '*', min: 0, path: ImplementationGuide.contact.telecom}
        isSummary: true
    maxLength: 0
    base: {max: '*', min: 0, path: ImplementationGuide.contact}
    isSummary: true
package_version: 1.4.0
class: resource
kind: resource
url: http://hl7.org/fhir/StructureDefinition/ImplementationGuide
base: http://hl7.org/fhir/StructureDefinition/DomainResource
version: null
required: [package, url, name, status, page]