description: Base StructureDefinition for ImplementationGuide Resource package_name: hl7.fhir.core derivation: specialization name: ImplementationGuide type: null elements: description: {type: string, short: Natural language description of the Implementation Guide, 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.', isSummary: true, index: 10} 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: 33} package: min: 1 short: Group of resources as used in .page.package index: 17 type: BackboneElement array: true elements: name: {type: string, short: Name used .page.package, isSummary: true, index: 18} description: {type: string, short: Human readable text describing the package, index: 19} resource: min: 1 short: Resource in the implementation guide index: 20 type: BackboneElement array: true elements: example: {type: boolean, 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.', isSummary: true, index: 21} name: {type: string, short: Human Name for the resource, isSummary: true, index: 22} 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: 23} 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: 24} 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. isSummary: true choices: [sourceUri, sourceReference] index: 26 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: 27} sourceReference: {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: Reference, choiceOf: source, isSummary: true, index: 28} exampleFor: type: Reference short: Resource this is an example of (if applicable) comments: |- Examples: * StructureDefinition -> Any * ValueSet -> expansion * OperationDefinition -> Parameters * Questionnaire -> QuestionnaireResponse. index: 29 required: [example, sourceReference, source, sourceUri] isSummary: true required: [resource, name] isSummary: true date: {short: Date for this version of the Implementation Guide, comments: Additional specific dates may be added as extensions., type: dateTime, isSummary: true, index: 9} dependency: type: BackboneElement short: Another Implementation guide this depends on isSummary: true array: true index: 14 elements: type: {short: reference | inclusion, comments: 'For information about processing included guides, see [Including Guides]{implementationguide.html#include}.', type: code, isSummary: true, index: 15} uri: {type: 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.', isSummary: true, index: 16} required: [uri, type] publisher: {short: Name of the publisher (Organization or individual), comments: 'Usually an organization, but may be an individual. This item SHOULD be populated unless the information is available from context.', type: string, isSummary: true, index: 5} fhirVersion: {type: id, 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.', isSummary: true, index: 13} global: type: BackboneElement short: Profiles that apply globally comments: See [Default Profiles](implementationguide.html#default) for a discussion of which resources are 'covered' by an implementation guide. isSummary: true array: true index: 30 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: 31} profile: {type: Reference, short: Profile that all resources must conform to, isSummary: true, index: 32} required: [profile, type] name: {type: string, short: Informal name for this Implementation Guide, comments: Not expected to be globally unique., isSummary: true, index: 2} useContext: {short: The implementation guide is intended to support these contexts, type: CodeableConcept, array: true, isSummary: true, index: 11} copyright: {type: string, short: Use and/or publishing restrictions, index: 12} experimental: {short: 'If for testing purposes, not real usage', 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: 34 elements: source: {type: uri, 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).', isSummary: true, index: 35} name: {type: string, short: Short name shown for navigational assistance, isSummary: true, index: 36} kind: {type: code, short: page | example | list | include | directory | dictionary | toc | resource, isSummary: true, index: 37} type: {type: code, short: Kind of resource to include in the list, array: true, index: 38} package: {type: string, short: Name of package to include, array: true, index: 39} format: {type: code, 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.', index: 40} page: short: Nested Pages / Sections comments: The implementation guide breadcrumbs are generated from this structure. elementReference: ['http://hl7.org/fhir/StructureDefinition/ImplementationGuide'] array: true index: 41 required: [name, kind, source] status: {isModifier: true, short: draft | active | retired, type: code, isSummary: true, index: 3} url: {short: Absolute URL used to reference this Implementation Guide, type: uri, isSummary: true, index: 0} version: {short: Logical id for this version of the Implementation Guide, type: string, isSummary: true, index: 1} contact: type: BackboneElement short: Contact details of the publisher comments: May be a web site, an email address, a telephone number (tel:), etc. isSummary: true array: true index: 6 elements: name: {type: string, short: Name of an individual to contact, comments: 'If there is no named individual, the telecom is for the organization as a whole.', isSummary: true, index: 7} telecom: {type: ContactPoint, short: Contact details for individual or publisher, isSummary: true, array: true, index: 8} 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]