R4 Draft for Comment

This page is part of the FHIR Specification (v3.2.0: R4 Ballot 1). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

5.10 Resource ImplementationGuideOutput - Content

FHIR Infrastructure Work GroupMaturity Level: 0 Draft Compartments: Not linked to any defined compartments

A set of rules of how FHIR is used to solve a particular problem. 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.

5.10.1 Scope and Usage

Placeholder for discussion of splitting ImplementationGuide. This resource is focused on use-cases for the ImplementationGuide after the publication process is complete, specifically:

  • Exposing metadata relevant for exposing an implementation guide in a registry
  • Information necessary to support using the implementation guide for instance validation (what resources are part of the IG, what default profiles are declared and imported/contained guides)
  • Information an IG authoring tool requires when refrencing a previously published IG as a dependency, including what artifacts are defined and what links are allowed.

5.10.2 Boundaries and Relationships

5.10.3 Resource Content

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. ImplementationGuideOutput DDomainResourceA set of rules about how FHIR is used
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
... url Σ1..1uriLogical URI to reference this implementation guide output (globally unique)
... version Σ0..1stringBusiness version of the implementation guide output
... name Σ1..1stringName for this implementation guide output (computer friendly)
... status ?!Σ1..1codedraft | active | retired | unknown
PublicationStatus (Required)
... experimental ?!Σ0..1booleanFor testing purposes, not real usage
... date Σ0..1dateTimeDate this was last changed
... publisher Σ0..1stringName of the publisher (organization or individual)
... contact Σ0..*ContactDetailContact details for the publisher
... description 0..1markdownNatural language description of the implementation guide output
... useContext Σ0..*UsageContextContext the content is intended to support
... jurisdiction Σ0..*CodeableConceptIntended jurisdiction for implementation guide output (if applicable)
Jurisdiction ValueSet (Extensible)
... copyright 0..1markdownUse and/or publishing restrictions
... fhirVersion Σ0..1idFHIR Version this Implementation Guide targets
... dependency Σ0..*BackboneElementAnother Implementation guide this depends on
.... type Σ1..1codereference | inclusion
GuideDependencyType (Required)
.... uri Σ1..1uriWhere to find dependency
... resource Σ1..*BackboneElementResource in the implementation guide
.... reference Σ1..1Reference(Any)Location of the resource
.... example[x] 0..1Is an example/What is this an example of?
..... exampleBooleanboolean
..... exampleReferenceReference(StructureDefinition)
.... relativePath 0..1stringRelative path for page in IG
... global Σ0..*BackboneElementProfiles that apply globally
.... type Σ1..1codeType this profiles applies to
ResourceType (Required)
.... profile Σ1..1Reference(StructureDefinition)Profile that all resources must conform to
... rendering Σ0..1uriLocation of rendered implementation guide
... page 0..*BackboneElementHTML page within the parent IG
.... name 1..1stringHTML page name
.... title 0..1stringTitle of the page
.... anchor 0..*stringAnchor available on the page
... image 0..*stringImage within the IG
... other 0..*stringAdditional linkable file in IG

doco Documentation for this format

UML Diagram (Legend)

ImplementationGuideOutput (DomainResource)An absolute URI that is used to identify this implementation guide output when it is referenced in a specification, model, design or an instance. This SHOULD be globally unique, and SHOULD be a literal address at which this implementation guide output is (or will be) publishedurl : uri [1..1]The identifier that is used to identify this version of the implementation guide output when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the implementation guide output author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequenceversion : string [0..1]A natural language name identifying the implementation guide output. This name should be usable as an identifier for the module by machine processing applications such as code generationname : string [1..1]The status of this implementation guide output. Enables tracking the life-cycle of the content (this element modifies the meaning of other elements)status : code [1..1] « The lifecycle status of a Value Set or Concept Map. (Strength=Required)PublicationStatus! »A boolean value to indicate that this implementation guide output is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage (this element modifies the meaning of other elements)experimental : boolean [0..1]The date (and optionally time) when the implementation guide output was published. The date must change if and when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the implementation guide output changesdate : dateTime [0..1]The name of the individual or organization that published the implementation guide outputpublisher : string [0..1]Contact details to assist a user in finding and communicating with the publishercontact : ContactDetail [0..*]A free text natural language description of the implementation guide output from a consumer's perspectivedescription : markdown [0..1]The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching for appropriate implementation guide output instancesuseContext : UsageContext [0..*]A legal or geographic region in which the implementation guide output is intended to be usedjurisdiction : CodeableConcept [0..*] « Countries and regions within which this artifact is targeted for use (Strength=Extensible)Jurisdiction ValueSet+ »A copyright statement relating to the implementation guide output and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the implementation guide outputcopyright : markdown [0..1]The version of the FHIR specification on which this ImplementationGuide is based - this is the formal version of the specification, without the revision number, e.g. [publication].[major].[minor], which is 3.2.0 for this versionfhirVersion : id [0..1]A pointer to official web page, PDF or other rendering of the implementation guiderendering : uri [0..1]Indicates a relative path to an image that exists within the IGimage : string [0..*]Indicates the relative path of an additional non-page, non-image file that is part of the IG - e.g. zip, jar and similar files that could be the target of a hyperlink in a derived IGother : string [0..*]DependencyHow the dependency is represented when the guide is publishedtype : code [1..1] « How a dependency is represented when the guide is published. (Strength=Required)GuideDependencyType! »Where the dependency is locateduri : uri [1..1]ResourceWhere this resource is foundreference : Reference [1..1] « Any »If true or a reference, indicates the resource is an example instance. If a reference is present, indicates that the example is an example of the specified profileexample[x] : Type [0..1] « boolean|Reference(StructureDefinition) »The relative path for primary page for this resource within the IGrelativePath : string [0..1]GlobalThe type of resource that all instances must conform totype : code [1..1] « One of the resource types defined as part of FHIR. (Strength=Required)ResourceType! »A reference to the profile that all instances must conform toprofile : Reference [1..1] « StructureDefinition »PageRelative path to the pagename : string [1..1]Label for the page intended for human displaytitle : string [0..1]The name of an anchor available on the pageanchor : string [0..*]Another implementation guide that this implementation depends on. Typically, an implementation guide uses value sets, profiles etc.defined in other implementation guidesdependency[0..*]A resource that is part of the implementation guide. Conformance resources (value set, structure definition, capability statements etc.) are obvious candidates for inclusion, but any kind of resource can be included as an example resourceresource[1..*]A set of profiles that all resources covered by this implementation guide must conform toglobal[0..*]Information about a page within the IGpage[0..*]

XML Template

<ImplementationGuideOutput xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <url value="[uri]"/><!-- 1..1 Logical URI to reference this implementation guide output (globally unique) -->
 <version value="[string]"/><!-- 0..1 Business version of the implementation guide output -->
 <name value="[string]"/><!-- 1..1 Name for this implementation guide output (computer friendly) -->
 <status value="[code]"/><!-- 1..1 draft | active | retired | unknown -->
 <experimental value="[boolean]"/><!-- 0..1 For testing purposes, not real usage -->
 <date value="[dateTime]"/><!-- 0..1 Date this was last changed -->
 <publisher value="[string]"/><!-- 0..1 Name of the publisher (organization or individual) -->
 <contact><!-- 0..* ContactDetail Contact details for the publisher --></contact>
 <description value="[markdown]"/><!-- 0..1 Natural language description of the implementation guide output -->
 <useContext><!-- 0..* UsageContext Context the content is intended to support --></useContext>
 <jurisdiction><!-- 0..* CodeableConcept Intended jurisdiction for implementation guide output (if applicable) --></jurisdiction>
 <copyright value="[markdown]"/><!-- 0..1 Use and/or publishing restrictions -->
 <fhirVersion value="[id]"/><!-- 0..1 FHIR Version this Implementation Guide targets -->
 <dependency>  <!-- 0..* Another Implementation guide this depends on -->
  <type value="[code]"/><!-- 1..1 reference | inclusion -->
  <uri value="[uri]"/><!-- 1..1 Where to find dependency -->
 </dependency>
 <resource>  <!-- 1..* Resource in the implementation guide -->
  <reference><!-- 1..1 Reference(Any) Location of the resource --></reference>
  <example[x]><!-- 0..1 boolean|Reference(StructureDefinition) Is an example/What is this an example of? --></example[x]>
  <relativePath value="[string]"/><!-- 0..1 Relative path for page in IG -->
 </resource>
 <global>  <!-- 0..* Profiles that apply globally -->
  <type value="[code]"/><!-- 1..1 Type this profiles applies to -->
  <profile><!-- 1..1 Reference(StructureDefinition) Profile that all resources must conform to --></profile>
 </global>
 <rendering value="[uri]"/><!-- 0..1 Location of rendered implementation guide -->
 <page>  <!-- 0..* HTML page within the parent IG -->
  <name value="[string]"/><!-- 1..1 HTML page name -->
  <title value="[string]"/><!-- 0..1 Title of the page -->
  <anchor value="[string]"/><!-- 0..* Anchor available on the page -->
 </page>
 <image value="[string]"/><!-- 0..* Image within the IG -->
 <other value="[string]"/><!-- 0..* Additional linkable file in IG -->
</ImplementationGuideOutput>

JSON Template

{doco
  "resourceType" : "ImplementationGuideOutput",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "url" : "<uri>", // R!  Logical URI to reference this implementation guide output (globally unique)
  "version" : "<string>", // Business version of the implementation guide output
  "name" : "<string>", // R!  Name for this implementation guide output (computer friendly)
  "status" : "<code>", // R!  draft | active | retired | unknown
  "experimental" : <boolean>, // For testing purposes, not real usage
  "date" : "<dateTime>", // Date this was last changed
  "publisher" : "<string>", // Name of the publisher (organization or individual)
  "contact" : [{ ContactDetail }], // Contact details for the publisher
  "description" : "<markdown>", // Natural language description of the implementation guide output
  "useContext" : [{ UsageContext }], // Context the content is intended to support
  "jurisdiction" : [{ CodeableConcept }], // Intended jurisdiction for implementation guide output (if applicable)
  "copyright" : "<markdown>", // Use and/or publishing restrictions
  "fhirVersion" : "<id>", // FHIR Version this Implementation Guide targets
  "dependency" : [{ // Another Implementation guide this depends on
    "type" : "<code>", // R!  reference | inclusion
    "uri" : "<uri>" // R!  Where to find dependency
  }],
  "resource" : [{ // R!  Resource in the implementation guide
    "reference" : { Reference(Any) }, // R!  Location of the resource
    // example[x]: Is an example/What is this an example of?. One of these 2:
    "exampleBoolean" : <boolean>,
    "exampleReference" : { Reference(StructureDefinition) },
    "relativePath" : "<string>" // Relative path for page in IG
  }],
  "global" : [{ // Profiles that apply globally
    "type" : "<code>", // R!  Type this profiles applies to
    "profile" : { Reference(StructureDefinition) } // R!  Profile that all resources must conform to
  }],
  "rendering" : "<uri>", // Location of rendered implementation guide
  "page" : [{ // HTML page within the parent IG
    "name" : "<string>", // R!  HTML page name
    "title" : "<string>", // Title of the page
    "anchor" : ["<string>"] // Anchor available on the page
  }],
  "image" : ["<string>"], // Image within the IG
  "other" : ["<string>"] // Additional linkable file in IG
}

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .doco


[ a fhir:ImplementationGuideOutput;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:ImplementationGuideOutput.url [ uri ]; # 1..1 Logical URI to reference this implementation guide output (globally unique)
  fhir:ImplementationGuideOutput.version [ string ]; # 0..1 Business version of the implementation guide output
  fhir:ImplementationGuideOutput.name [ string ]; # 1..1 Name for this implementation guide output (computer friendly)
  fhir:ImplementationGuideOutput.status [ code ]; # 1..1 draft | active | retired | unknown
  fhir:ImplementationGuideOutput.experimental [ boolean ]; # 0..1 For testing purposes, not real usage
  fhir:ImplementationGuideOutput.date [ dateTime ]; # 0..1 Date this was last changed
  fhir:ImplementationGuideOutput.publisher [ string ]; # 0..1 Name of the publisher (organization or individual)
  fhir:ImplementationGuideOutput.contact [ ContactDetail ], ... ; # 0..* Contact details for the publisher
  fhir:ImplementationGuideOutput.description [ markdown ]; # 0..1 Natural language description of the implementation guide output
  fhir:ImplementationGuideOutput.useContext [ UsageContext ], ... ; # 0..* Context the content is intended to support
  fhir:ImplementationGuideOutput.jurisdiction [ CodeableConcept ], ... ; # 0..* Intended jurisdiction for implementation guide output (if applicable)
  fhir:ImplementationGuideOutput.copyright [ markdown ]; # 0..1 Use and/or publishing restrictions
  fhir:ImplementationGuideOutput.fhirVersion [ id ]; # 0..1 FHIR Version this Implementation Guide targets
  fhir:ImplementationGuideOutput.dependency [ # 0..* Another Implementation guide this depends on
    fhir:ImplementationGuideOutput.dependency.type [ code ]; # 1..1 reference | inclusion
    fhir:ImplementationGuideOutput.dependency.uri [ uri ]; # 1..1 Where to find dependency
  ], ...;
  fhir:ImplementationGuideOutput.resource [ # 1..* Resource in the implementation guide
    fhir:ImplementationGuideOutput.resource.reference [ Reference(Any) ]; # 1..1 Location of the resource
    # ImplementationGuideOutput.resource.example[x] : 0..1 Is an example/What is this an example of?. One of these 2
      fhir:ImplementationGuideOutput.resource.exampleBoolean [ boolean ]
      fhir:ImplementationGuideOutput.resource.exampleReference [ Reference(StructureDefinition) ]
    fhir:ImplementationGuideOutput.resource.relativePath [ string ]; # 0..1 Relative path for page in IG
  ], ...;
  fhir:ImplementationGuideOutput.global [ # 0..* Profiles that apply globally
    fhir:ImplementationGuideOutput.global.type [ code ]; # 1..1 Type this profiles applies to
    fhir:ImplementationGuideOutput.global.profile [ Reference(StructureDefinition) ]; # 1..1 Profile that all resources must conform to
  ], ...;
  fhir:ImplementationGuideOutput.rendering [ uri ]; # 0..1 Location of rendered implementation guide
  fhir:ImplementationGuideOutput.page [ # 0..* HTML page within the parent IG
    fhir:ImplementationGuideOutput.page.name [ string ]; # 1..1 HTML page name
    fhir:ImplementationGuideOutput.page.title [ string ]; # 0..1 Title of the page
    fhir:ImplementationGuideOutput.page.anchor [ string ], ... ; # 0..* Anchor available on the page
  ], ...;
  fhir:ImplementationGuideOutput.image [ string ], ... ; # 0..* Image within the IG
  fhir:ImplementationGuideOutput.other [ string ], ... ; # 0..* Additional linkable file in IG
]

Changes since DSTU2

This resource did not exist in Release 2

This analysis is available as XML or JSON.

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. ImplementationGuideOutput DDomainResourceA set of rules about how FHIR is used
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
... url Σ1..1uriLogical URI to reference this implementation guide output (globally unique)
... version Σ0..1stringBusiness version of the implementation guide output
... name Σ1..1stringName for this implementation guide output (computer friendly)
... status ?!Σ1..1codedraft | active | retired | unknown
PublicationStatus (Required)
... experimental ?!Σ0..1booleanFor testing purposes, not real usage
... date Σ0..1dateTimeDate this was last changed
... publisher Σ0..1stringName of the publisher (organization or individual)
... contact Σ0..*ContactDetailContact details for the publisher
... description 0..1markdownNatural language description of the implementation guide output
... useContext Σ0..*UsageContextContext the content is intended to support
... jurisdiction Σ0..*CodeableConceptIntended jurisdiction for implementation guide output (if applicable)
Jurisdiction ValueSet (Extensible)
... copyright 0..1markdownUse and/or publishing restrictions
... fhirVersion Σ0..1idFHIR Version this Implementation Guide targets
... dependency Σ0..*BackboneElementAnother Implementation guide this depends on
.... type Σ1..1codereference | inclusion
GuideDependencyType (Required)
.... uri Σ1..1uriWhere to find dependency
... resource Σ1..*BackboneElementResource in the implementation guide
.... reference Σ1..1Reference(Any)Location of the resource
.... example[x] 0..1Is an example/What is this an example of?
..... exampleBooleanboolean
..... exampleReferenceReference(StructureDefinition)
.... relativePath 0..1stringRelative path for page in IG
... global Σ0..*BackboneElementProfiles that apply globally
.... type Σ1..1codeType this profiles applies to
ResourceType (Required)
.... profile Σ1..1Reference(StructureDefinition)Profile that all resources must conform to
... rendering Σ0..1uriLocation of rendered implementation guide
... page 0..*BackboneElementHTML page within the parent IG
.... name 1..1stringHTML page name
.... title 0..1stringTitle of the page
.... anchor 0..*stringAnchor available on the page
... image 0..*stringImage within the IG
... other 0..*stringAdditional linkable file in IG

doco Documentation for this format

UML Diagram (Legend)

ImplementationGuideOutput (DomainResource)An absolute URI that is used to identify this implementation guide output when it is referenced in a specification, model, design or an instance. This SHOULD be globally unique, and SHOULD be a literal address at which this implementation guide output is (or will be) publishedurl : uri [1..1]The identifier that is used to identify this version of the implementation guide output when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the implementation guide output author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequenceversion : string [0..1]A natural language name identifying the implementation guide output. This name should be usable as an identifier for the module by machine processing applications such as code generationname : string [1..1]The status of this implementation guide output. Enables tracking the life-cycle of the content (this element modifies the meaning of other elements)status : code [1..1] « The lifecycle status of a Value Set or Concept Map. (Strength=Required)PublicationStatus! »A boolean value to indicate that this implementation guide output is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage (this element modifies the meaning of other elements)experimental : boolean [0..1]The date (and optionally time) when the implementation guide output was published. The date must change if and when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the implementation guide output changesdate : dateTime [0..1]The name of the individual or organization that published the implementation guide outputpublisher : string [0..1]Contact details to assist a user in finding and communicating with the publishercontact : ContactDetail [0..*]A free text natural language description of the implementation guide output from a consumer's perspectivedescription : markdown [0..1]The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching for appropriate implementation guide output instancesuseContext : UsageContext [0..*]A legal or geographic region in which the implementation guide output is intended to be usedjurisdiction : CodeableConcept [0..*] « Countries and regions within which this artifact is targeted for use (Strength=Extensible)Jurisdiction ValueSet+ »A copyright statement relating to the implementation guide output and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the implementation guide outputcopyright : markdown [0..1]The version of the FHIR specification on which this ImplementationGuide is based - this is the formal version of the specification, without the revision number, e.g. [publication].[major].[minor], which is 3.2.0 for this versionfhirVersion : id [0..1]A pointer to official web page, PDF or other rendering of the implementation guiderendering : uri [0..1]Indicates a relative path to an image that exists within the IGimage : string [0..*]Indicates the relative path of an additional non-page, non-image file that is part of the IG - e.g. zip, jar and similar files that could be the target of a hyperlink in a derived IGother : string [0..*]DependencyHow the dependency is represented when the guide is publishedtype : code [1..1] « How a dependency is represented when the guide is published. (Strength=Required)GuideDependencyType! »Where the dependency is locateduri : uri [1..1]ResourceWhere this resource is foundreference : Reference [1..1] « Any »If true or a reference, indicates the resource is an example instance. If a reference is present, indicates that the example is an example of the specified profileexample[x] : Type [0..1] « boolean|Reference(StructureDefinition) »The relative path for primary page for this resource within the IGrelativePath : string [0..1]GlobalThe type of resource that all instances must conform totype : code [1..1] « One of the resource types defined as part of FHIR. (Strength=Required)ResourceType! »A reference to the profile that all instances must conform toprofile : Reference [1..1] « StructureDefinition »PageRelative path to the pagename : string [1..1]Label for the page intended for human displaytitle : string [0..1]The name of an anchor available on the pageanchor : string [0..*]Another implementation guide that this implementation depends on. Typically, an implementation guide uses value sets, profiles etc.defined in other implementation guidesdependency[0..*]A resource that is part of the implementation guide. Conformance resources (value set, structure definition, capability statements etc.) are obvious candidates for inclusion, but any kind of resource can be included as an example resourceresource[1..*]A set of profiles that all resources covered by this implementation guide must conform toglobal[0..*]Information about a page within the IGpage[0..*]

XML Template

<ImplementationGuideOutput xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <url value="[uri]"/><!-- 1..1 Logical URI to reference this implementation guide output (globally unique) -->
 <version value="[string]"/><!-- 0..1 Business version of the implementation guide output -->
 <name value="[string]"/><!-- 1..1 Name for this implementation guide output (computer friendly) -->
 <status value="[code]"/><!-- 1..1 draft | active | retired | unknown -->
 <experimental value="[boolean]"/><!-- 0..1 For testing purposes, not real usage -->
 <date value="[dateTime]"/><!-- 0..1 Date this was last changed -->
 <publisher value="[string]"/><!-- 0..1 Name of the publisher (organization or individual) -->
 <contact><!-- 0..* ContactDetail Contact details for the publisher --></contact>
 <description value="[markdown]"/><!-- 0..1 Natural language description of the implementation guide output -->
 <useContext><!-- 0..* UsageContext Context the content is intended to support --></useContext>
 <jurisdiction><!-- 0..* CodeableConcept Intended jurisdiction for implementation guide output (if applicable) --></jurisdiction>
 <copyright value="[markdown]"/><!-- 0..1 Use and/or publishing restrictions -->
 <fhirVersion value="[id]"/><!-- 0..1 FHIR Version this Implementation Guide targets -->
 <dependency>  <!-- 0..* Another Implementation guide this depends on -->
  <type value="[code]"/><!-- 1..1 reference | inclusion -->
  <uri value="[uri]"/><!-- 1..1 Where to find dependency -->
 </dependency>
 <resource>  <!-- 1..* Resource in the implementation guide -->
  <reference><!-- 1..1 Reference(Any) Location of the resource --></reference>
  <example[x]><!-- 0..1 boolean|Reference(StructureDefinition) Is an example/What is this an example of? --></example[x]>
  <relativePath value="[string]"/><!-- 0..1 Relative path for page in IG -->
 </resource>
 <global>  <!-- 0..* Profiles that apply globally -->
  <type value="[code]"/><!-- 1..1 Type this profiles applies to -->
  <profile><!-- 1..1 Reference(StructureDefinition) Profile that all resources must conform to --></profile>
 </global>
 <rendering value="[uri]"/><!-- 0..1 Location of rendered implementation guide -->
 <page>  <!-- 0..* HTML page within the parent IG -->
  <name value="[string]"/><!-- 1..1 HTML page name -->
  <title value="[string]"/><!-- 0..1 Title of the page -->
  <anchor value="[string]"/><!-- 0..* Anchor available on the page -->
 </page>
 <image value="[string]"/><!-- 0..* Image within the IG -->
 <other value="[string]"/><!-- 0..* Additional linkable file in IG -->
</ImplementationGuideOutput>

JSON Template

{doco
  "resourceType" : "ImplementationGuideOutput",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "url" : "<uri>", // R!  Logical URI to reference this implementation guide output (globally unique)
  "version" : "<string>", // Business version of the implementation guide output
  "name" : "<string>", // R!  Name for this implementation guide output (computer friendly)
  "status" : "<code>", // R!  draft | active | retired | unknown
  "experimental" : <boolean>, // For testing purposes, not real usage
  "date" : "<dateTime>", // Date this was last changed
  "publisher" : "<string>", // Name of the publisher (organization or individual)
  "contact" : [{ ContactDetail }], // Contact details for the publisher
  "description" : "<markdown>", // Natural language description of the implementation guide output
  "useContext" : [{ UsageContext }], // Context the content is intended to support
  "jurisdiction" : [{ CodeableConcept }], // Intended jurisdiction for implementation guide output (if applicable)
  "copyright" : "<markdown>", // Use and/or publishing restrictions
  "fhirVersion" : "<id>", // FHIR Version this Implementation Guide targets
  "dependency" : [{ // Another Implementation guide this depends on
    "type" : "<code>", // R!  reference | inclusion
    "uri" : "<uri>" // R!  Where to find dependency
  }],
  "resource" : [{ // R!  Resource in the implementation guide
    "reference" : { Reference(Any) }, // R!  Location of the resource
    // example[x]: Is an example/What is this an example of?. One of these 2:
    "exampleBoolean" : <boolean>,
    "exampleReference" : { Reference(StructureDefinition) },
    "relativePath" : "<string>" // Relative path for page in IG
  }],
  "global" : [{ // Profiles that apply globally
    "type" : "<code>", // R!  Type this profiles applies to
    "profile" : { Reference(StructureDefinition) } // R!  Profile that all resources must conform to
  }],
  "rendering" : "<uri>", // Location of rendered implementation guide
  "page" : [{ // HTML page within the parent IG
    "name" : "<string>", // R!  HTML page name
    "title" : "<string>", // Title of the page
    "anchor" : ["<string>"] // Anchor available on the page
  }],
  "image" : ["<string>"], // Image within the IG
  "other" : ["<string>"] // Additional linkable file in IG
}

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .doco


[ a fhir:ImplementationGuideOutput;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:ImplementationGuideOutput.url [ uri ]; # 1..1 Logical URI to reference this implementation guide output (globally unique)
  fhir:ImplementationGuideOutput.version [ string ]; # 0..1 Business version of the implementation guide output
  fhir:ImplementationGuideOutput.name [ string ]; # 1..1 Name for this implementation guide output (computer friendly)
  fhir:ImplementationGuideOutput.status [ code ]; # 1..1 draft | active | retired | unknown
  fhir:ImplementationGuideOutput.experimental [ boolean ]; # 0..1 For testing purposes, not real usage
  fhir:ImplementationGuideOutput.date [ dateTime ]; # 0..1 Date this was last changed
  fhir:ImplementationGuideOutput.publisher [ string ]; # 0..1 Name of the publisher (organization or individual)
  fhir:ImplementationGuideOutput.contact [ ContactDetail ], ... ; # 0..* Contact details for the publisher
  fhir:ImplementationGuideOutput.description [ markdown ]; # 0..1 Natural language description of the implementation guide output
  fhir:ImplementationGuideOutput.useContext [ UsageContext ], ... ; # 0..* Context the content is intended to support
  fhir:ImplementationGuideOutput.jurisdiction [ CodeableConcept ], ... ; # 0..* Intended jurisdiction for implementation guide output (if applicable)
  fhir:ImplementationGuideOutput.copyright [ markdown ]; # 0..1 Use and/or publishing restrictions
  fhir:ImplementationGuideOutput.fhirVersion [ id ]; # 0..1 FHIR Version this Implementation Guide targets
  fhir:ImplementationGuideOutput.dependency [ # 0..* Another Implementation guide this depends on
    fhir:ImplementationGuideOutput.dependency.type [ code ]; # 1..1 reference | inclusion
    fhir:ImplementationGuideOutput.dependency.uri [ uri ]; # 1..1 Where to find dependency
  ], ...;
  fhir:ImplementationGuideOutput.resource [ # 1..* Resource in the implementation guide
    fhir:ImplementationGuideOutput.resource.reference [ Reference(Any) ]; # 1..1 Location of the resource
    # ImplementationGuideOutput.resource.example[x] : 0..1 Is an example/What is this an example of?. One of these 2
      fhir:ImplementationGuideOutput.resource.exampleBoolean [ boolean ]
      fhir:ImplementationGuideOutput.resource.exampleReference [ Reference(StructureDefinition) ]
    fhir:ImplementationGuideOutput.resource.relativePath [ string ]; # 0..1 Relative path for page in IG
  ], ...;
  fhir:ImplementationGuideOutput.global [ # 0..* Profiles that apply globally
    fhir:ImplementationGuideOutput.global.type [ code ]; # 1..1 Type this profiles applies to
    fhir:ImplementationGuideOutput.global.profile [ Reference(StructureDefinition) ]; # 1..1 Profile that all resources must conform to
  ], ...;
  fhir:ImplementationGuideOutput.rendering [ uri ]; # 0..1 Location of rendered implementation guide
  fhir:ImplementationGuideOutput.page [ # 0..* HTML page within the parent IG
    fhir:ImplementationGuideOutput.page.name [ string ]; # 1..1 HTML page name
    fhir:ImplementationGuideOutput.page.title [ string ]; # 0..1 Title of the page
    fhir:ImplementationGuideOutput.page.anchor [ string ], ... ; # 0..* Anchor available on the page
  ], ...;
  fhir:ImplementationGuideOutput.image [ string ], ... ; # 0..* Image within the IG
  fhir:ImplementationGuideOutput.other [ string ], ... ; # 0..* Additional linkable file in IG
]

Changes since DSTU2

This resource did not exist in Release 2

This analysis is available as XML or JSON.

 

Alternate definitions: Master Definition (XML, JSON), XML Schema/Schematron + JSON Schema, ShEx (for Turtle) + see the extensions & the dependency analysis

5.10.3.1 Terminology Bindings

PathDefinitionTypeReference
ImplementationGuideOutput.status The lifecycle status of a Value Set or Concept Map.RequiredPublicationStatus
ImplementationGuideOutput.jurisdiction Countries and regions within which this artifact is targeted for useExtensibleJurisdiction ValueSet
ImplementationGuideOutput.dependency.type How a dependency is represented when the guide is published.RequiredGuideDependencyType
ImplementationGuideOutput.global.type One of the resource types defined as part of FHIR.RequiredResource Types

5.10.4 Search Parameters

Search parameters for this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.

NameTypeDescriptionExpressionIn Common
datedateThe implementation guide output publication dateImplementationGuideOutput.date
dependencyuriWhere to find dependencyImplementationGuideOutput.dependency.uri
descriptionstringThe description of the implementation guide outputImplementationGuideOutput.description
experimentaltokenFor testing purposes, not real usageImplementationGuideOutput.experimental
jurisdictiontokenIntended jurisdiction for the implementation guide outputImplementationGuideOutput.jurisdiction
namestringComputationally friendly name of the implementation guide outputImplementationGuideOutput.name
publisherstringName of the publisher of the implementation guide outputImplementationGuideOutput.publisher
resourcereferenceLocation of the resourceImplementationGuideOutput.resource.reference
(Any)
statustokenThe current status of the implementation guide outputImplementationGuideOutput.status
urluriThe uri that identifies the implementation guide outputImplementationGuideOutput.url
versiontokenThe business version of the implementation guide outputImplementationGuideOutput.version