description: Base StructureDefinition for ImplementationGuide Resource package_name: hl7.fhir.core derivation: specialization name: ImplementationGuide type: ImplementationGuide elements: description: {type: markdown, short: Natural language description of the implementation guide, comments: 'This description can be used to capture details such as why the implementation guide was built, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the module as conveyed in the text field of the resource itself. This item SHOULD be populated unless the information is available from context.', index: 8} binary: {type: uri, short: 'Image, css, script, etc.', comments: 'This is principally included for the FHIR publishing tool, but may be useful when extracting and reusing content from the implementation guide.', array: true, index: 32} package: type: BackboneElement short: Group of resources as used in .page.package isSummary: true array: true index: 16 elements: name: {type: string, short: Name used .page.package, isSummary: true, index: 17} description: {type: string, short: Human readable text describing the package, index: 18} resource: min: 1 short: Resource in the implementation guide index: 19 type: BackboneElement array: true elements: example: {short: 'If not an example, has it''s normal meaning', 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, isSummary: true, index: 20} name: {type: string, short: Human Name for the resource, isSummary: true, index: 21} description: {type: string, short: Reason why included in guide, comments: This is mostly used with examples to explain why it is present (though they can have extensive comments in the examples)., index: 22} acronym: {type: string, short: Short code to identify the resource, 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).', index: 23} source: short: Location of the resource 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. choices: [sourceUri, sourceReference] isSummary: true index: 25 sourceUri: {short: Location of the resource, 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, choiceOf: source, isSummary: true, index: 26} sourceReference: short: Location of the resource refers: ['http://hl7.org/fhir/StructureDefinition/Resource'] 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 choiceOf: source isSummary: true index: 27 exampleFor: short: Resource this is an example of (if applicable) refers: ['http://hl7.org/fhir/StructureDefinition/StructureDefinition'] comments: |- Examples: * StructureDefinition -> Any * ValueSet -> expansion * OperationDefinition -> Parameters * Questionnaire -> QuestionnaireResponse. type: Reference index: 28 required: [example, sourceReference, source, sourceUri] isSummary: true required: [resource, name] date: {short: Date this was last changed, comments: 'Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the implementation guide. Additional specific dates may be added as extensions.', type: dateTime, isSummary: true, index: 7} dependency: type: BackboneElement short: Another Implementation guide this depends on isSummary: true array: true index: 13 elements: type: {short: reference | inclusion, comments: 'For information about processing included guides, see [Including Guides]{implementationguide.html#include}.', type: code, isSummary: true, index: 14} uri: {short: Where to find dependency, comments: 'When a guide is published, and the type is ''include'', this will be a relative reference within the guide.', type: uri, isSummary: true, index: 15} required: [uri, type] publisher: {short: Name of the publisher (Organization or individual), comments: 'Usually an organization, but may be an individual. The publisher (or steward) of the implementation guide is the organization or individual primarily responsible for the maintenance and upkeep of the implementation guide. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the implementation guide. This item SHOULD be populated unless the information is available from context.', type: string, isSummary: true, index: 5} fhirVersion: {short: FHIR Version this Implementation Guide targets, comments: 'An Implementation Guide should specify the target it applies to, as ImplementationGuides are rarely valid across multiple versions of FHIR.', type: id, isSummary: true, index: 12} jurisdiction: {short: Intended jurisdiction for implementation guide (if applicable), type: CodeableConcept, array: true, isSummary: true, index: 10} global: short: Profiles that apply globally comments: See [Default Profiles](implementationguide.html#default) for a discussion of which resources are 'covered' by an implementation guide. type: BackboneElement array: true isSummary: true index: 29 elements: type: {short: Type this profiles applies to, 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, isSummary: true, index: 30} profile: short: Profile that all resources must conform to refers: ['http://hl7.org/fhir/StructureDefinition/StructureDefinition'] type: Reference isSummary: true index: 31 required: [profile, type] name: {short: Name for this implementation guide (Computer friendly), comments: The name is not expected to be globally unique. The name should be a simple alpha-numeric type name to ensure it is computable friendly., type: string, isSummary: true, index: 2} useContext: {short: Content intends to support these contexts, comments: 'When multiple usageContexts are specified, there is no expectation for whether all or any of the contexts apply.', type: UsageContext, array: true, isSummary: true, index: 9} copyright: {short: Use and/or publishing restrictions, type: markdown, index: 11} experimental: {isModifier: true, short: 'If for testing purposes, not real usage', comments: Allows filtering of implementation guide that are appropriate for use vs. not., type: boolean, isSummary: true, index: 4} page: short: Page/Section in the Guide comments: Pages automatically become sections if they have sub-pages. By convention, the home page is called index.html. type: BackboneElement isSummary: true index: 33 elements: source: {short: Where to find that page, 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, isSummary: true, index: 34} title: {type: string, short: Short title shown for navigational assistance, isSummary: true, index: 35} kind: {short: page | example | list | include | directory | dictionary | toc | resource, type: code, isSummary: true, index: 36} type: {type: code, short: Kind of resource to include in the list, array: true, index: 37} package: {type: string, short: Name of package to include, array: true, index: 38} format: {short: 'Format of the page (e.g. html, markdown, etc.)', 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, index: 39} page: short: Nested Pages / Sections comments: The implementation guide breadcrumbs are generated from this structure. elementReference: ['http://hl7.org/fhir/StructureDefinition/ImplementationGuide', elements, page] array: true index: 40 required: [kind, title, source] status: {isModifier: true, short: draft | active | retired, comments: Allows filtering of implementation guide that are appropriate for use vs. not., type: code, isSummary: true, index: 3} url: {short: Logical uri to reference this implementation guide (globally unique), comments: 'Can be a urn:uuid: or a urn:oid:, but real http: addresses are preferred.', type: uri, isSummary: true, index: 0} version: {short: Business version of the implementation guide, comments: There may be multiple different instances of a implementation guide that have the same identifier but different versions., type: string, isSummary: true, index: 1} contact: {short: Contact details for the publisher, comments: 'May be a web site, an email address, a telephone number, etc.', type: ContactDetail, array: true, isSummary: true, index: 6} package_version: 1.8.0 class: resource kind: resource url: http://hl7.org/fhir/StructureDefinition/ImplementationGuide base: http://hl7.org/fhir/StructureDefinition/DomainResource version: null required: [url, name, status]