FHIR Extensions Pack
5.1.0 - 5.1.0 (April 2024) International flag

This page is part of the FHIR Core Extensions Registry (v5.1.0: Release 5.1) based on FHIR (HL7® FHIR® Standard) v5.0.0. This is the current published version. For a full list of available versions, see the Directory of published versions

Extension: ImplementationGuide Source File

Official URL: http://hl7.org/fhir/StructureDefinition/implementationguide-sourceFile Version: 5.1.0
Standards status: Trial-use Maturity Level: 2 Computable Name: IGSourceFile
Other Identifiers: OID:2.16.840.1.113883.4.642.5.1372

Identifies files used as part of the the publication process other than resources referenced in definition.resource.

Context of Use

This extension may be used on the following element(s):

  • Element ID ImplementationGuide.definition

Usage info

Usage:

  • This Extension is not used by any profiles in this Implementation Guide

Changes since version 1.0.0:

  • No changes

    • Formal Views of Extension Content

    Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.

    This structure is derived from Extension

    Summary

    Complex Extension: Identifies files used as part of the the publication process other than resources referenced in definition.resource.

    • file: Reference: The location of the file on a server used by the IG publication process
    • location: string: The relative path (with respect to the IG base folder) and name of the file as it should be positioned prior to processing by the IG publisher
    • keepAsResource: boolean: The default behavior if the Reference is to a Media or DocumentReference is for the 'attachment' to be what is persisted in the 'location'. If this flag is set to true, then the referenced resource will be persisted 'as is' - I.e. a Media or DocumentReference.

    Maturity: 2

    This structure is derived from Extension

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Extension 0..* Extension Additional files used in publication
    ... Slices for extension Content/Rules for all slices
    .... extension:file 1..1 Extension Location on server
    ..... extension 0..0
    ..... url 1..1 uri "file"
    ..... value[x] 1..1 Reference() Value of extension
    .... extension:location 1..1 Extension Path for publisher
    ..... extension 0..0
    ..... url 1..1 uri "file"
    ..... value[x] 1..1 string Value of extension
    .... extension:keepAsResource 0..1 Extension Use attachment or resource?
    ..... extension 0..0
    ..... url 1..1 uri "file"
    ..... value[x] 1..1 boolean Value of extension
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/implementationguide-sourceFile"
    ... value[x] 0..0

    doco Documentation for this format
    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Extension 0..* Extension Additional files used in publication
    ... id 0..1 id Unique id for inter-element referencing
    ... Slices for extension 2..* Extension Additional content defined by implementations
    Slice: Unordered, Open by value:url
    .... extension:file 1..1 Extension Location on server
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..0
    ..... url 1..1 uri "file"
    ..... value[x] 1..1 Reference() Value of extension
    .... extension:location 1..1 Extension Path for publisher
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..0
    ..... url 1..1 uri "file"
    ..... value[x] 1..1 string Value of extension
    .... extension:keepAsResource 0..1 Extension Use attachment or resource?
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..0
    ..... url 1..1 uri "file"
    ..... value[x] 1..1 boolean Value of extension
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/implementationguide-sourceFile"

    doco Documentation for this format

    This structure is derived from Extension

    Summary

    Complex Extension: Identifies files used as part of the the publication process other than resources referenced in definition.resource.

    • file: Reference: The location of the file on a server used by the IG publication process
    • location: string: The relative path (with respect to the IG base folder) and name of the file as it should be positioned prior to processing by the IG publisher
    • keepAsResource: boolean: The default behavior if the Reference is to a Media or DocumentReference is for the 'attachment' to be what is persisted in the 'location'. If this flag is set to true, then the referenced resource will be persisted 'as is' - I.e. a Media or DocumentReference.

    Maturity: 2

    Differential View

    This structure is derived from Extension

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Extension 0..* Extension Additional files used in publication
    ... Slices for extension Content/Rules for all slices
    .... extension:file 1..1 Extension Location on server
    ..... extension 0..0
    ..... url 1..1 uri "file"
    ..... value[x] 1..1 Reference() Value of extension
    .... extension:location 1..1 Extension Path for publisher
    ..... extension 0..0
    ..... url 1..1 uri "file"
    ..... value[x] 1..1 string Value of extension
    .... extension:keepAsResource 0..1 Extension Use attachment or resource?
    ..... extension 0..0
    ..... url 1..1 uri "file"
    ..... value[x] 1..1 boolean Value of extension
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/implementationguide-sourceFile"
    ... value[x] 0..0

    doco Documentation for this format

    Snapshot View

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Extension 0..* Extension Additional files used in publication
    ... id 0..1 id Unique id for inter-element referencing
    ... Slices for extension 2..* Extension Additional content defined by implementations
    Slice: Unordered, Open by value:url
    .... extension:file 1..1 Extension Location on server
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..0
    ..... url 1..1 uri "file"
    ..... value[x] 1..1 Reference() Value of extension
    .... extension:location 1..1 Extension Path for publisher
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..0
    ..... url 1..1 uri "file"
    ..... value[x] 1..1 string Value of extension
    .... extension:keepAsResource 0..1 Extension Use attachment or resource?
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..0
    ..... url 1..1 uri "file"
    ..... value[x] 1..1 boolean Value of extension
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/implementationguide-sourceFile"

    doco Documentation for this format

     

    Other representations of profile: CSV, Excel, Schematron

    Constraints

    IdGradePath(s)DetailsRequirements
    ele-1error**ALL** elementsAll FHIR elements must have a @value or children
    : hasValue() or (children().count() > id.count())
    ext-1error**ALL** extensionsMust have either extensions or value[x], not both
    : extension.exists() != value.exists()

    Search Parameters for this Extension

    (none found)