{
"description": "A set of rules of how a particular interoperability or standards problem is solved - typically through the use of FHIR resources. 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.",
"_filename": "StructureDefinition-ImplementationGuide.json",
"package_name": "hl7.fhir.r6.core",
"date": "2025-12-18T07:07:42+11:00",
"derivation": "specialization",
"meta": {
"lastUpdated": "2025-12-18T07:07:42.170+11:00"
},
"publisher": "HL7 International / FHIR Infrastructure",
"fhirVersion": "6.0.0-ballot4",
"jurisdiction": [ {
"coding": [ {
"code": "001",
"system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
"display": "World"
} ]
} ],
"purpose": "An implementation guide is able to define default profiles that must apply to any use of a resource, so validation services may need to take one or more implementation guide resources when validating.",
"name": "ImplementationGuide",
"mapping": [ {
"uri": "http://hl7.org/fhir/fivews",
"name": "FiveWs Pattern Mapping",
"identity": "w5"
}, {
"uri": "http://hl7.org/v3",
"name": "RIM Mapping",
"identity": "rim"
}, {
"uri": "http://hl7.org/fhir/object-implementation",
"name": "Object Implementation Information",
"identity": "objimpl"
} ],
"abstract": false,
"type": "ImplementationGuide",
"experimental": "false",
"resourceType": "StructureDefinition",
"title": null,
"package_version": "6.0.0-ballot4",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-category",
"valueString": "Foundation.Conformance"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-implements",
"valueCanonical": "http://hl7.org/fhir/StructureDefinition/CanonicalResource"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "normative"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode": "fhir"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger": 4
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category",
"valueCode": "anonymous"
} ],
"snapshot": {
"element": [ {
"constraint": [ {
"key": "cnl-0",
"human": "Name should be usable as an identifier for the module by machine processing applications such as code generation",
"source": "http://hl7.org/fhir/StructureDefinition/ImplementationGuide",
"severity": "warning",
"expression": "name.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$')"
}, {
"key": "ig-2",
"human": "If a resource has a fhirVersion, it must be one of the versions defined for the Implementation Guide",
"source": "http://hl7.org/fhir/StructureDefinition/ImplementationGuide",
"severity": "error",
"expression": "definition.resource.fhirVersion.all(%context.fhirVersion contains $this)"
} ],
"path": "ImplementationGuide",
"min": 0,
"definition": "A set of rules of how a particular interoperability or standards problem is solved - typically through the use of FHIR resources. 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.",
"isModifier": false,
"short": "A set of rules about how FHIR is used",
"mapping": [ {
"map": "conformance.behavior,conformance.misc",
"identity": "w5"
}, {
"map": "n/a",
"identity": "rim"
} ],
"mustSupport": false,
"max": "*",
"id": "ImplementationGuide",
"base": {
"max": "*",
"min": 0,
"path": "ImplementationGuide"
},
"isSummary": false
}, {
"path": "ImplementationGuide.id",
"min": 0,
"definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"isModifier": false,
"short": "Logical id of this artifact",
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
} ]
} ],
"mustSupport": false,
"max": "1",
"id": "ImplementationGuide.id",
"comment": "Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.",
"base": {
"max": "1",
"min": 0,
"path": "Resource.id"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ImplementationGuide.meta",
"min": 0,
"definition": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"isModifier": false,
"short": "Metadata about the resource",
"type": [ {
"code": "Meta"
} ],
"mustSupport": false,
"max": "1",
"id": "ImplementationGuide.meta",
"base": {
"max": "1",
"min": 0,
"path": "Resource.meta"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ImplementationGuide.implicitRules",
"min": 0,
"definition": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. For DomainResources, if more than one implicitRules policy applies, additional policies may be conveyed using the [additionalImplicitRules](https://build.fhir.org/ig/HL7/fhir-extensions/StructureDefinition-additionalImplicitRules.html) extension.",
"isModifier": true,
"short": "A set of rules under which this content was created",
"type": [ {
"code": "uri"
} ],
"mustSupport": false,
"max": "1",
"id": "ImplementationGuide.implicitRules",
"comment": "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.",
"base": {
"max": "1",
"min": 0,
"path": "Resource.implicitRules"
},
"isModifierReason": "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation",
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ImplementationGuide.language",
"min": 0,
"definition": "The base language in which the resource is written.",
"isModifier": false,
"short": "Language of the resource content",
"type": [ {
"code": "code"
} ],
"mustSupport": false,
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/all-languages|6.0.0-ballot4",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Language"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
} ],
"additional": [ {
"purpose": "starter",
"valueSet": "http://hl7.org/fhir/ValueSet/languages"
} ],
"description": "IETF language tag for a human language"
},
"max": "1",
"id": "ImplementationGuide.language",
"comment": "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"base": {
"max": "1",
"min": 0,
"path": "Resource.language"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ImplementationGuide.text",
"min": 0,
"definition": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"isModifier": false,
"short": "Text summary of the resource, for human interpretation",
"mapping": [ {
"map": "Act.text?",
"identity": "rim"
} ],
"type": [ {
"code": "Narrative"
} ],
"mustSupport": false,
"alias": [ "narrative", "html", "xhtml", "display" ],
"max": "1",
"id": "ImplementationGuide.text",
"condition": [ "dom-6" ],
"comment": "Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded information is added later.",
"base": {
"max": "1",
"min": 0,
"path": "DomainResource.text"
},
"isSummary": false
}, {
"path": "ImplementationGuide.contained",
"min": 0,
"definition": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.",
"isModifier": false,
"short": "Contained, inline Resources",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Resource"
} ],
"mustSupport": false,
"alias": [ "inline resources", "anonymous resources", "contained resources" ],
"max": "*",
"id": "ImplementationGuide.contained",
"condition": [ "dom-2", "dom-4", "dom-3", "dom-5" ],
"comment": "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels. Contained resources may be a resource type defined in the FHIR specification, or an [additional resource](resource.html#additional).",
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.contained"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ImplementationGuide.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"isModifier": false,
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"mustSupport": false,
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "ImplementationGuide.extension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.extension"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ImplementationGuide.modifierExtension",
"requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"isModifier": true,
"short": "Extensions that cannot be ignored",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"mustSupport": false,
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "ImplementationGuide.modifierExtension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.modifierExtension"
},
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them",
"isSummary": true
}, {
"constraint": [ {
"key": "cnl-1",
"human": "URL should not contain | or # - these characters make processing canonical references problematic",
"source": "http://hl7.org/fhir/StructureDefinition/ImplementationGuide",
"severity": "warning",
"expression": "exists() implies matches('^[^|# ]+$')"
}, {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ImplementationGuide.url",
"requirements": "Allows the implementation guide to be referenced by a single globally unique identifier. This is required to allow hosting Implementation Guides on multiple different servers, and to allow for the editorial process.",
"min": 1,
"definition": "An absolute URI that is used to identify this implementation guide when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this implementation guide is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the implementation guide is stored on different servers.",
"isModifier": false,
"short": "Canonical identifier for this implementation guide, represented as a URI (globally unique)",
"mapping": [ {
"map": "FiveWs.identifier",
"identity": "w5"
} ],
"type": [ {
"code": "uri"
} ],
"mustSupport": false,
"alias": [ "url", "authoritative-url", "destination", "identity" ],
"max": "1",
"id": "ImplementationGuide.url",
"comment": "Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.\n\nThe determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in [Technical and Business Versions](resource.html#versions). \n\nIn some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the [meta.source](resource.html#meta) element to indicate where the current master source of the resource can be found.",
"base": {
"max": "1",
"min": 1,
"path": "ImplementationGuide.url"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ImplementationGuide.identifier",
"requirements": "Allows externally provided and/or usable business identifiers to be easily associated with the module.",
"min": 0,
"definition": "A formal identifier that is used to identify this implementation guide when it is represented in other formats, or referenced in a specification, model, design or an instance.",
"isModifier": false,
"short": "Additional identifier for the implementation guide (business identifier)",
"mapping": [ {
"map": "FiveWs.identifier",
"identity": "w5"
} ],
"type": [ {
"code": "Identifier"
} ],
"mustSupport": false,
"max": "*",
"id": "ImplementationGuide.identifier",
"base": {
"max": "*",
"min": 0,
"path": "ImplementationGuide.identifier"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ImplementationGuide.version",
"min": 0,
"definition": "The identifier that is used to identify this version of the implementation guide when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the implementation guide 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 sequence.",
"isModifier": false,
"short": "Business version of the implementation guide",
"mapping": [ {
"map": "FiveWs.version",
"identity": "w5"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"max": "1",
"id": "ImplementationGuide.version",
"comment": "There may be different implementation guide instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the implementation guide with the format [url]|[version]. The version SHOULD NOT contain a '#' - see [Business Version](resource.html#bv-format).",
"base": {
"max": "1",
"min": 0,
"path": "ImplementationGuide.version"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ImplementationGuide.versionAlgorithm[x]",
"min": 0,
"definition": "Indicates the mechanism used to compare versions to determine which is more current.",
"isModifier": false,
"short": "How to compare versions",
"type": [ {
"code": "string"
}, {
"code": "Coding"
} ],
"mustSupport": false,
"binding": {
"strength": "extensible",
"valueSet": "http://hl7.org/fhir/ValueSet/version-algorithm"
},
"max": "1",
"id": "ImplementationGuide.versionAlgorithm[x]",
"comment": "If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 and a 0 if the version ordering can't be successfully be determined.",
"base": {
"max": "1",
"min": 0,
"path": "ImplementationGuide.versionAlgorithm[x]"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ImplementationGuide.name",
"requirements": "Support human navigation and code generation.",
"min": 1,
"definition": "A natural language name identifying the implementation guide. This name should be usable as an identifier for the module by machine processing applications such as code generation.",
"isModifier": false,
"short": "Name for this implementation guide (computer friendly)",
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"max": "1",
"id": "ImplementationGuide.name",
"condition": [ "cnl-0" ],
"comment": "The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.",
"base": {
"max": "1",
"min": 1,
"path": "ImplementationGuide.name"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ImplementationGuide.title",
"min": 0,
"definition": "A short, descriptive, user-friendly title for the implementation guide.",
"isModifier": false,
"short": "Name for this implementation guide (human friendly)",
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "ImplementationGuide.title",
"comment": "This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.",
"base": {
"max": "1",
"min": 0,
"path": "ImplementationGuide.title"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ImplementationGuide.status",
"min": 1,
"definition": "The status of this implementation guide. Enables tracking the life-cycle of the content.",
"isModifier": true,
"short": "draft | active | retired | unknown",
"mapping": [ {
"map": "FiveWs.status",
"identity": "w5"
} ],
"type": [ {
"code": "code"
} ],
"mustSupport": false,
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/publication-status|6.0.0-ballot4",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "PublicationStatus"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
} ],
"description": "The lifecycle status of an artifact."
},
"max": "1",
"id": "ImplementationGuide.status",
"comment": "Allows filtering of implementation guides that are appropriate for use versus not.\n\nSee guidance around (not) making local changes to elements [here](canonicalresource.html#localization).",
"base": {
"max": "1",
"min": 1,
"path": "ImplementationGuide.status"
},
"isModifierReason": "This is labeled as \"Is Modifier\" because applications should not use a retired {{title}} without due consideration",
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ImplementationGuide.experimental",
"requirements": "Enables experimental content to be developed following the same lifecycle that would be used for a production-level implementation guide.",
"min": 0,
"definition": "A Boolean value to indicate that this implementation guide is authored for testing purposes (or education/evaluation/marketing) and no version of this resource will ever be intended for genuine usage.",
"isModifier": false,
"short": "For testing only - never for real usage",
"mapping": [ {
"map": "FiveWs.class",
"identity": "w5"
} ],
"type": [ {
"code": "boolean"
} ],
"mustSupport": false,
"meaningWhenMissing": "If absent, this resource is treated as though it is not experimental.",
"max": "1",
"id": "ImplementationGuide.experimental",
"comment": "Allows filtering of implementation guides that are appropriate for use versus not. Experimental resources might include example instances in implementation guides, instances created solely for testing purposes, etc. If experimental is 'true' for any version of a resource, it should be true for all versions of the resource. (If experimental changes, then it is being misused or a resource that was never intended for real-world use has unexpectedly changed its purpose.).\n\nExperimental resources are not expected to be stable and may well have breaking changes without a corresponding change to the 'version' element.",
"base": {
"max": "1",
"min": 0,
"path": "ImplementationGuide.experimental"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ImplementationGuide.date",
"min": 0,
"definition": "The date (and optionally time) when the implementation guide was last significantly changed. The date must change 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 changes.",
"isModifier": false,
"short": "Date last changed",
"mapping": [ {
"map": "FiveWs.recorded",
"identity": "w5"
} ],
"type": [ {
"code": "dateTime"
} ],
"mustSupport": false,
"alias": [ "Revision Date" ],
"max": "1",
"id": "ImplementationGuide.date",
"comment": "The date is often not tracked until the resource is published, but may be present on draft content. 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 or be found by consulting Provenances associated with past versions of the resource.\n\nSee guidance around (not) making local changes to elements [here](canonicalresource.html#localization).",
"base": {
"max": "1",
"min": 0,
"path": "ImplementationGuide.date"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ImplementationGuide.publisher",
"requirements": "Helps establish the \"authority/credibility\" of the implementation guide. May also allow for contact.",
"min": 0,
"definition": "The name of the organization or individual responsible for the release and ongoing maintenance of the implementation guide.",
"isModifier": false,
"short": "Name of the publisher/steward (organization or individual)",
"mapping": [ {
"map": "FiveWs.witness",
"identity": "w5"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "ImplementationGuide.publisher",
"comment": "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.",
"base": {
"max": "1",
"min": 0,
"path": "ImplementationGuide.publisher"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ImplementationGuide.contact",
"min": 0,
"definition": "Contact details to assist a user in finding and communicating with the publisher.",
"isModifier": false,
"short": "Contact details for the publisher",
"type": [ {
"code": "ContactDetail"
} ],
"mustSupport": false,
"max": "*",
"id": "ImplementationGuide.contact",
"comment": "May be a web site, an email address, a telephone number, etc.\n\nSee guidance around (not) making local changes to elements [here](canonicalresource.html#localization).",
"base": {
"max": "*",
"min": 0,
"path": "ImplementationGuide.contact"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ImplementationGuide.description",
"min": 0,
"definition": "A free text natural language description of the implementation guide from a consumer's perspective.",
"isModifier": false,
"short": "Natural language description of the implementation guide",
"type": [ {
"code": "markdown"
} ],
"mustSupport": false,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "ImplementationGuide.description",
"comment": "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 implementation guide as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the implementation guide is presumed to be the predominant language in the place the implementation guide was created).",
"base": {
"max": "1",
"min": 0,
"path": "ImplementationGuide.description"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ImplementationGuide.useContext",
"requirements": "Assist in searching for appropriate content.",
"min": 0,
"definition": "The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate implementation guide instances.",
"isModifier": false,
"short": "The context that the content is intended to support",
"type": [ {
"code": "UsageContext"
} ],
"mustSupport": false,
"max": "*",
"id": "ImplementationGuide.useContext",
"comment": "When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.",
"base": {
"max": "*",
"min": 0,
"path": "ImplementationGuide.useContext"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ImplementationGuide.jurisdiction",
"min": 0,
"definition": "A legal or geographic region in which the authority that maintains the resource is operating. In general, the jurisdiction is also found in the useContext. The useContext may reference additional jurisdictions because the defining jurisdiction does not necessarily limit the jurisdictions of use.",
"isModifier": false,
"short": "Jurisdiction of the authority that maintains the implementation guide (if applicable)",
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": false,
"binding": {
"strength": "extensible",
"valueSet": "http://terminology.hl7.org/ValueSet/jurisdiction",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Jurisdiction"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
} ],
"description": "Countries and regions within which this artifact is targeted for use."
},
"max": "*",
"id": "ImplementationGuide.jurisdiction",
"comment": "It may be possible for the implementation guide to be used in jurisdictions other than those for which it was originally designed or intended.\n\nDEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'jurisdiction' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#jurisdiction and useContext.valueCodeableConcept indicating the jurisdiction.)",
"base": {
"max": "*",
"min": 0,
"path": "ImplementationGuide.jurisdiction"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ImplementationGuide.purpose",
"min": 0,
"definition": "Explanation of why this implementation guide is needed and why it has been designed as it has.",
"isModifier": false,
"short": "Why this implementation guide is defined",
"mapping": [ {
"map": "FiveWs.why[x]",
"identity": "w5"
}, {
"map": "no-gen-base",
"identity": "objimpl"
} ],
"type": [ {
"code": "markdown"
} ],
"mustSupport": false,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "ImplementationGuide.purpose",
"comment": "This element does not describe the usage of the implementation guide. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this implementation guide.",
"base": {
"max": "1",
"min": 0,
"path": "ImplementationGuide.purpose"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ImplementationGuide.copyright",
"requirements": "Consumers must be able to determine any legal restrictions on the use of the implementation guide and/or its content.",
"min": 0,
"definition": "A copyright statement relating to the implementation guide and/or its contents. Copyright statements are notices of intellectual property ownership and can include restrictions on the use and publishing of the implementation guide.",
"isModifier": false,
"short": "Notice about intellectual property ownership, can include restrictions on use",
"mapping": [ {
"map": "no-gen-base",
"identity": "objimpl"
} ],
"type": [ {
"code": "markdown"
} ],
"mustSupport": false,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"alias": [ "License", "Restrictions" ],
"max": "1",
"id": "ImplementationGuide.copyright",
"comment": "...",
"base": {
"max": "1",
"min": 0,
"path": "ImplementationGuide.copyright"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ImplementationGuide.copyrightLabel",
"requirements": "Defines the content expected to be rendered in all representations of the artifact.",
"min": 0,
"definition": "A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are restricted. (e.g. 'All rights reserved', 'Some rights reserved').",
"isModifier": false,
"short": "Copyright holder and year(s)",
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "ImplementationGuide.copyrightLabel",
"comment": "The copyright symbol and the '(c)' textual representation SHOULD NOT be included in this string. It will be added by software when rendering the notation. Full details about licensing, restrictions, warrantees, etc. goes in the more general 'copyright' element.",
"base": {
"max": "1",
"min": 0,
"path": "ImplementationGuide.copyrightLabel"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ImplementationGuide.packageId",
"min": 1,
"definition": "The NPM package name for this Implementation Guide, used in the NPM package distribution, which is the primary mechanism by which FHIR based tooling manages IG dependencies. This value must be globally unique, and should be assigned with care.",
"isModifier": false,
"short": "NPM Package name for IG",
"type": [ {
"code": "id"
} ],
"mustSupport": false,
"max": "1",
"id": "ImplementationGuide.packageId",
"comment": "Many (if not all) IG publishing tools will require that this element be present. For implementation guides published through HL7 or the FHIR foundation, the FHIR product director assigns package IDs.",
"base": {
"max": "1",
"min": 1,
"path": "ImplementationGuide.packageId"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ImplementationGuide.license",
"min": 0,
"definition": "The license that applies to this Implementation Guide, using an SPDX license code, or 'not-open-source'.",
"isModifier": false,
"short": "SPDX license code for this IG (or not-open-source)",
"type": [ {
"code": "code"
} ],
"mustSupport": false,
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/spdx-license|6.0.0-ballot4",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "SPDXLicense"
} ],
"description": "The license that applies to an Implementation Guide (using an SPDX license Identifiers, or 'not-open-source'). The binding is required but new SPDX license Identifiers are allowed to be used (https://spdx.org/licenses/)."
},
"max": "1",
"id": "ImplementationGuide.license",
"base": {
"max": "1",
"min": 0,
"path": "ImplementationGuide.license"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ImplementationGuide.fhirVersion",
"min": 1,
"definition": "The version(s) of the FHIR specification that this ImplementationGuide targets - e.g. describes how to use. The value of this element is the formal version of the specification, without the revision number, e.g. [publication].[major].[minor], which is 4.6.0. for this version.",
"isModifier": false,
"short": "FHIR Version(s) this Implementation Guide targets",
"type": [ {
"code": "code"
} ],
"mustSupport": false,
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/FHIR-version|6.0.0-ballot4",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "FHIRVersion"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
} ],
"description": "All published FHIR Versions."
},
"max": "*",
"id": "ImplementationGuide.fhirVersion",
"condition": [ "ig-2" ],
"comment": "Most implementation guides target a single version - e.g. they describe how to use a particular version, and the profiles and examples etc. are valid for that version. But some implementation guides describe how to use multiple different versions of FHIR to solve the same problem, or in concert with each other. Typically, the requirement to support multiple versions arises as implementation matures and different implementation communities are stuck at different versions by regulation or market dynamics.",
"base": {
"max": "*",
"min": 1,
"path": "ImplementationGuide.fhirVersion"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children or both",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ImplementationGuide.dependsOn",
"min": 0,
"definition": "Another implementation guide that this implementation depends on. Typically, an implementation guide uses value sets, profiles etc.defined in other implementation guides.",
"isModifier": false,
"short": "Another Implementation guide this depends on",
"type": [ {
"code": "BackboneElement"
} ],
"mustSupport": false,
"max": "*",
"id": "ImplementationGuide.dependsOn",
"base": {
"max": "*",
"min": 0,
"path": "ImplementationGuide.dependsOn"
},
"isSummary": true
}, {
"path": "ImplementationGuide.dependsOn.id",
"min": 0,
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"isModifier": false,
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ImplementationGuide.dependsOn.id",
"condition": [ "ele-1" ],
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ImplementationGuide.dependsOn.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"isModifier": false,
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "ImplementationGuide.dependsOn.extension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ImplementationGuide.dependsOn.modifierExtension",
"requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"isModifier": true,
"short": "Extensions that cannot be ignored even if unrecognized",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "ImplementationGuide.dependsOn.modifierExtension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "BackboneElement.modifierExtension"
},
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ImplementationGuide.dependsOn.uri",
"min": 1,
"definition": "A canonical reference to the Implementation guide for the dependency.",
"isModifier": false,
"short": "Identity of the IG that this depends on",
"type": [ {
"code": "canonical",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/ImplementationGuide" ]
} ],
"mustSupport": false,
"max": "1",
"id": "ImplementationGuide.dependsOn.uri",
"comment": "Usually, A canonical reference to the implementation guide is the same as the master location at which the implementation guide is published.",
"base": {
"max": "1",
"min": 1,
"path": "ImplementationGuide.dependsOn.uri"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ImplementationGuide.dependsOn.packageId",
"min": 0,
"definition": "The NPM package name for the Implementation Guide that this IG depends on.",
"isModifier": false,
"short": "NPM Package name for IG this depends on",
"type": [ {
"code": "id"
} ],
"mustSupport": false,
"max": "1",
"id": "ImplementationGuide.dependsOn.packageId",
"base": {
"max": "1",
"min": 0,
"path": "ImplementationGuide.dependsOn.packageId"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ImplementationGuide.dependsOn.version",
"min": 0,
"definition": "The version of the IG that is depended on, when the correct version is required to understand the IG correctly.",
"isModifier": false,
"short": "Version of the IG",
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"max": "1",
"id": "ImplementationGuide.dependsOn.version",
"comment": "This follows the syntax of the NPM packaging version field - see [[reference]].",
"base": {
"max": "1",
"min": 0,
"path": "ImplementationGuide.dependsOn.version"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ImplementationGuide.dependsOn.reason",
"min": 0,
"definition": "A description explaining the nature of the dependency on the listed IG.",
"isModifier": false,
"short": "Why dependency exists",
"type": [ {
"code": "markdown"
} ],
"mustSupport": false,
"max": "1",
"id": "ImplementationGuide.dependsOn.reason",
"comment": "This doesn't need to enumerate every resource used, but should give some sense of why the dependency exists. It will be used in the rendered list of dependencies",
"base": {
"max": "1",
"min": 0,
"path": "ImplementationGuide.dependsOn.reason"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children or both",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ImplementationGuide.global",
"min": 0,
"definition": "A set of profiles that all resources covered by this implementation guide must conform to.",
"isModifier": false,
"short": "Profiles that apply globally",
"type": [ {
"code": "BackboneElement"
} ],
"mustSupport": false,
"max": "*",
"id": "ImplementationGuide.global",
"comment": "See [Default Profiles](implementationguide.html#default) for a discussion of which resources are 'covered' by an implementation guide.",
"base": {
"max": "*",
"min": 0,
"path": "ImplementationGuide.global"
},
"isSummary": true
}, {
"path": "ImplementationGuide.global.id",
"min": 0,
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"isModifier": false,
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ImplementationGuide.global.id",
"condition": [ "ele-1" ],
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ImplementationGuide.global.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"isModifier": false,
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "ImplementationGuide.global.extension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ImplementationGuide.global.modifierExtension",
"requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"isModifier": true,
"short": "Extensions that cannot be ignored even if unrecognized",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "ImplementationGuide.global.modifierExtension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "BackboneElement.modifierExtension"
},
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ImplementationGuide.global.type",
"min": 1,
"definition": "The type of resource that all instances must conform to.",
"isModifier": false,
"short": "Type this profile applies to",
"type": [ {
"code": "code"
} ],
"mustSupport": false,
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/resource-types|6.0.0-ballot4",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ResourceType"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
} ],
"description": "One of the resource types defined as part of this version of FHIR."
},
"max": "1",
"id": "ImplementationGuide.global.type",
"comment": "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.",
"base": {
"max": "1",
"min": 1,
"path": "ImplementationGuide.global.type"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ImplementationGuide.global.profile",
"min": 1,
"definition": "A reference to the profile that all instances must conform to.",
"isModifier": false,
"short": "Profile that all resources must conform to",
"type": [ {
"code": "canonical",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/StructureDefinition" ]
} ],
"mustSupport": false,
"max": "1",
"id": "ImplementationGuide.global.profile",
"base": {
"max": "1",
"min": 1,
"path": "ImplementationGuide.global.profile"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children or both",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ig-1",
"human": "If a resource has a groupingId, it must refer to a grouping defined in the Implementation Guide",
"source": "http://hl7.org/fhir/StructureDefinition/ImplementationGuide",
"severity": "error",
"expression": "resource.groupingId.all(%context.grouping.id contains $this)"
} ],
"path": "ImplementationGuide.definition",
"min": 0,
"definition": "The information needed by an IG publisher tool to publish the whole implementation guide.",
"isModifier": false,
"short": "Information needed to build the IG",
"type": [ {
"code": "BackboneElement"
} ],
"mustSupport": false,
"max": "1",
"id": "ImplementationGuide.definition",
"condition": [ "ig-2" ],
"comment": "Principally, this consists of information abuot source resource and file locations, and build parameters and templates.",
"base": {
"max": "1",
"min": 0,
"path": "ImplementationGuide.definition"
},
"isSummary": false
}, {
"path": "ImplementationGuide.definition.id",
"min": 0,
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"isModifier": false,
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ImplementationGuide.definition.id",
"condition": [ "ele-1" ],
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ImplementationGuide.definition.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"isModifier": false,
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "ImplementationGuide.definition.extension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ImplementationGuide.definition.modifierExtension",
"requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"isModifier": true,
"short": "Extensions that cannot be ignored even if unrecognized",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "ImplementationGuide.definition.modifierExtension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "BackboneElement.modifierExtension"
},
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children or both",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ImplementationGuide.definition.grouping",
"min": 0,
"definition": "A logical group of resources. Logical groups can be used when building pages.",
"isModifier": false,
"short": "Grouping used to present related resources in the IG",
"type": [ {
"code": "BackboneElement"
} ],
"mustSupport": false,
"max": "*",
"id": "ImplementationGuide.definition.grouping",
"condition": [ "ig-1" ],
"comment": "Groupings are arbitrary sub-divisions of content. Typically, they are used to help build Table of Contents automatically.",
"base": {
"max": "*",
"min": 0,
"path": "ImplementationGuide.definition.grouping"
},
"isSummary": false
}, {
"path": "ImplementationGuide.definition.grouping.id",
"min": 0,
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"isModifier": false,
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ImplementationGuide.definition.grouping.id",
"condition": [ "ele-1" ],
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ImplementationGuide.definition.grouping.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"isModifier": false,
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "ImplementationGuide.definition.grouping.extension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ImplementationGuide.definition.grouping.modifierExtension",
"requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"isModifier": true,
"short": "Extensions that cannot be ignored even if unrecognized",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "ImplementationGuide.definition.grouping.modifierExtension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "BackboneElement.modifierExtension"
},
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ImplementationGuide.definition.grouping.name",
"min": 1,
"definition": "The human-readable title to display for the package of resources when rendering the implementation guide.",
"isModifier": false,
"short": "Descriptive name for the package",
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "ImplementationGuide.definition.grouping.name",
"base": {
"max": "1",
"min": 1,
"path": "ImplementationGuide.definition.grouping.name"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ImplementationGuide.definition.grouping.description",
"min": 0,
"definition": "Human readable text describing the package.",
"isModifier": false,
"short": "Human readable text describing the package",
"type": [ {
"code": "markdown"
} ],
"mustSupport": false,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "ImplementationGuide.definition.grouping.description",
"base": {
"max": "1",
"min": 0,
"path": "ImplementationGuide.definition.grouping.description"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children or both",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ImplementationGuide.definition.resource",
"min": 0,
"definition": "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 resource.",
"isModifier": false,
"short": "Resource in the implementation guide",
"type": [ {
"code": "BackboneElement"
} ],
"mustSupport": false,
"max": "*",
"id": "ImplementationGuide.definition.resource",
"condition": [ "ig-2", "ig-1" ],
"base": {
"max": "*",
"min": 0,
"path": "ImplementationGuide.definition.resource"
},
"isSummary": false
}, {
"path": "ImplementationGuide.definition.resource.id",
"min": 0,
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"isModifier": false,
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ImplementationGuide.definition.resource.id",
"condition": [ "ele-1" ],
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ImplementationGuide.definition.resource.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"isModifier": false,
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "ImplementationGuide.definition.resource.extension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ImplementationGuide.definition.resource.modifierExtension",
"requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"isModifier": true,
"short": "Extensions that cannot be ignored even if unrecognized",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "ImplementationGuide.definition.resource.modifierExtension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "BackboneElement.modifierExtension"
},
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ImplementationGuide.definition.resource.reference",
"min": 1,
"definition": "Where this resource is found.",
"isModifier": false,
"short": "Location of the resource",
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Resource" ]
} ],
"mustSupport": false,
"max": "1",
"id": "ImplementationGuide.definition.resource.reference",
"comment": "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.",
"base": {
"max": "1",
"min": 1,
"path": "ImplementationGuide.definition.resource.reference"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ImplementationGuide.definition.resource.fhirVersion",
"min": 0,
"definition": "Indicates the FHIR Version(s) this artifact is intended to apply to. If no versions are specified, the resource is assumed to apply to all the versions stated in ImplementationGuide.fhirVersion.",
"isModifier": false,
"short": "Versions this applies to (if different to IG)",
"type": [ {
"code": "code"
} ],
"mustSupport": false,
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/FHIR-version|6.0.0-ballot4",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "FHIRVersion"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
} ],
"description": "All published FHIR Versions."
},
"max": "*",
"id": "ImplementationGuide.definition.resource.fhirVersion",
"condition": [ "ig-2" ],
"comment": "The resource SHALL be valid against all the versions it is specified to apply to. If the resource referred to is a StructureDefinition, the fhirVersion stated in the StructureDefinition cannot disagree with the version specified here; the specified versions SHALL include the version specified by the StructureDefinition, and may include additional versions using the [http://hl7.org/fhir/StructureDefinition/structuredefinition-applicable-version](https://build.fhir.org/ig/HL7/fhir-extensions/StructureDefinition-structuredefinition-applicable-version.html) extension.",
"base": {
"max": "*",
"min": 0,
"path": "ImplementationGuide.definition.resource.fhirVersion"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ImplementationGuide.definition.resource.name",
"min": 0,
"definition": "A human assigned name for the resource. All resources SHOULD have a name, but the name may be extracted from the resource (e.g. ValueSet.name).",
"isModifier": false,
"short": "Human readable name for the resource",
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "ImplementationGuide.definition.resource.name",
"base": {
"max": "1",
"min": 0,
"path": "ImplementationGuide.definition.resource.name"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ImplementationGuide.definition.resource.description",
"min": 0,
"definition": "A description of the reason that a resource has been included in the implementation guide.",
"isModifier": false,
"short": "Reason why included in guide",
"type": [ {
"code": "markdown"
} ],
"mustSupport": false,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "ImplementationGuide.definition.resource.description",
"comment": "This is mostly used with examples to explain why it is present (though they can have extensive comments in the examples).",
"base": {
"max": "1",
"min": 0,
"path": "ImplementationGuide.definition.resource.description"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ImplementationGuide.definition.resource.isExample",
"min": 0,
"definition": "If true, indicates the resource is an example instance.",
"isModifier": false,
"short": "Is this an example",
"type": [ {
"code": "boolean"
} ],
"mustSupport": false,
"max": "1",
"id": "ImplementationGuide.definition.resource.isExample",
"base": {
"max": "1",
"min": 0,
"path": "ImplementationGuide.definition.resource.isExample"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ImplementationGuide.definition.resource.profile",
"min": 0,
"definition": "If present, indicates profile(s) the instance is valid against.",
"isModifier": false,
"short": "Profile(s) this resource is valid against",
"type": [ {
"code": "canonical",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/StructureDefinition" ]
} ],
"mustSupport": false,
"max": "*",
"id": "ImplementationGuide.definition.resource.profile",
"comment": "This can be used for both example and non-example resources to indicate profiles they are expected to be valid against. E.g. a non-example ValueSet might be declared to be a valid 'ShareableValueSet'",
"base": {
"max": "*",
"min": 0,
"path": "ImplementationGuide.definition.resource.profile"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ImplementationGuide.definition.resource.groupingId",
"min": 0,
"definition": "Reference to the id of the grouping this resource appears in.",
"isModifier": false,
"short": "Grouping this is part of",
"type": [ {
"code": "id"
} ],
"mustSupport": false,
"max": "1",
"id": "ImplementationGuide.definition.resource.groupingId",
"condition": [ "ig-1" ],
"comment": "This must correspond to a group.id element within this implementation guide.",
"base": {
"max": "1",
"min": 0,
"path": "ImplementationGuide.definition.resource.groupingId"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children or both",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ig-3",
"human": "Source must be absent if 'generated' is generated",
"source": "http://hl7.org/fhir/StructureDefinition/ImplementationGuide",
"severity": "error",
"expression": "generation='generated' implies source.empty()"
} ],
"path": "ImplementationGuide.definition.page",
"min": 0,
"definition": "A page / section in the implementation guide. The root page is the implementation guide home page.",
"isModifier": false,
"short": "Page/Section in the Guide",
"type": [ {
"code": "BackboneElement"
} ],
"mustSupport": false,
"max": "1",
"id": "ImplementationGuide.definition.page",
"comment": "Pages automatically become sections if they have sub-pages. By convention, the home page is called index.html.",
"base": {
"max": "1",
"min": 0,
"path": "ImplementationGuide.definition.page"
},
"isSummary": false
}, {
"path": "ImplementationGuide.definition.page.id",
"min": 0,
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"isModifier": false,
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ImplementationGuide.definition.page.id",
"condition": [ "ele-1" ],
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ImplementationGuide.definition.page.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"isModifier": false,
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "ImplementationGuide.definition.page.extension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ImplementationGuide.definition.page.modifierExtension",
"requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"isModifier": true,
"short": "Extensions that cannot be ignored even if unrecognized",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "ImplementationGuide.definition.page.modifierExtension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "BackboneElement.modifierExtension"
},
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ImplementationGuide.definition.page.source[x]",
"min": 0,
"definition": "Indicates the URL or the actual content to provide for the page.",
"isModifier": false,
"short": "Source for page",
"type": [ {
"code": "url"
}, {
"code": "string"
}, {
"code": "markdown"
} ],
"mustSupport": false,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "ImplementationGuide.definition.page.source[x]",
"condition": [ "ig-3" ],
"comment": "If absent and the page isn't a generated page, this may be inferred from the page name by checking input locations. String is used for XHTML content - sent as an escaped string. FHIR tooling can't support 'direct' XHTML anywhere other than in narrative.",
"base": {
"max": "1",
"min": 0,
"path": "ImplementationGuide.definition.page.source[x]"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ImplementationGuide.definition.page.name",
"min": 1,
"definition": "The url by which the page should be known when published.",
"isModifier": false,
"short": "Name of the page when published",
"type": [ {
"code": "url"
} ],
"mustSupport": false,
"max": "1",
"id": "ImplementationGuide.definition.page.name",
"comment": "This SHALL be a local reference, expressed with respect to the root of the IG output folder. No suffix is required. If no suffix is specified, .html will be appended.",
"base": {
"max": "1",
"min": 1,
"path": "ImplementationGuide.definition.page.name"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ImplementationGuide.definition.page.title",
"min": 1,
"definition": "A short title used to represent this page in navigational structures such as table of contents, bread crumbs, etc.",
"isModifier": false,
"short": "Short title shown for navigational assistance",
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "ImplementationGuide.definition.page.title",
"base": {
"max": "1",
"min": 1,
"path": "ImplementationGuide.definition.page.title"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ImplementationGuide.definition.page.generation",
"min": 1,
"definition": "A code that indicates how the page is generated.",
"isModifier": false,
"short": "html | markdown | xml | generated",
"type": [ {
"code": "code"
} ],
"mustSupport": false,
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/guide-page-generation|6.0.0-ballot4",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "GuidePageGeneration"
} ],
"description": "A code that indicates how the page is generated."
},
"max": "1",
"id": "ImplementationGuide.definition.page.generation",
"condition": [ "ig-3" ],
"base": {
"max": "1",
"min": 1,
"path": "ImplementationGuide.definition.page.generation"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ImplementationGuide.definition.page.page",
"min": 0,
"definition": "Nested Pages/Sections under this page.",
"isModifier": false,
"short": "Nested Pages / Sections",
"contentReference": "#ImplementationGuide.definition.page",
"mustSupport": false,
"max": "*",
"id": "ImplementationGuide.definition.page.page",
"comment": "The implementation guide breadcrumbs may be generated from this structure.",
"base": {
"max": "*",
"min": 0,
"path": "ImplementationGuide.definition.page.page"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children or both",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ImplementationGuide.definition.parameter",
"min": 0,
"definition": "A set of parameters that defines how the implementation guide is built. The parameters are defined by the relevant tools that build the implementation guides.",
"isModifier": false,
"short": "Defines how IG is built by tools",
"type": [ {
"code": "BackboneElement"
} ],
"mustSupport": false,
"max": "*",
"id": "ImplementationGuide.definition.parameter",
"comment": "see [confluence](https://confluence.hl7.org/display/FHIR/Implementation+Guide+Parameters) for the parameters defined by the HL7 IG publisher.",
"base": {
"max": "*",
"min": 0,
"path": "ImplementationGuide.definition.parameter"
},
"isSummary": false
}, {
"path": "ImplementationGuide.definition.parameter.id",
"min": 0,
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"isModifier": false,
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ImplementationGuide.definition.parameter.id",
"condition": [ "ele-1" ],
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ImplementationGuide.definition.parameter.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"isModifier": false,
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "ImplementationGuide.definition.parameter.extension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ImplementationGuide.definition.parameter.modifierExtension",
"requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"isModifier": true,
"short": "Extensions that cannot be ignored even if unrecognized",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "ImplementationGuide.definition.parameter.modifierExtension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "BackboneElement.modifierExtension"
},
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ImplementationGuide.definition.parameter.code",
"min": 1,
"definition": "A tool-specific code that defines the parameter.",
"isModifier": false,
"short": "Code that identifies parameter",
"type": [ {
"code": "Coding"
} ],
"mustSupport": false,
"binding": {
"strength": "extensible",
"valueSet": "http://hl7.org/fhir/ValueSet/guide-parameter-code"
},
"max": "1",
"id": "ImplementationGuide.definition.parameter.code",
"base": {
"max": "1",
"min": 1,
"path": "ImplementationGuide.definition.parameter.code"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ImplementationGuide.definition.parameter.value",
"min": 1,
"definition": "Value for named type.",
"isModifier": false,
"short": "Value for named type",
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"max": "1",
"id": "ImplementationGuide.definition.parameter.value",
"base": {
"max": "1",
"min": 1,
"path": "ImplementationGuide.definition.parameter.value"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children or both",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ImplementationGuide.definition.template",
"min": 0,
"definition": "A template for building resources.",
"isModifier": false,
"short": "A template for building resources",
"type": [ {
"code": "BackboneElement"
} ],
"mustSupport": false,
"max": "*",
"id": "ImplementationGuide.definition.template",
"base": {
"max": "*",
"min": 0,
"path": "ImplementationGuide.definition.template"
},
"isSummary": false
}, {
"path": "ImplementationGuide.definition.template.id",
"min": 0,
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"isModifier": false,
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ImplementationGuide.definition.template.id",
"condition": [ "ele-1" ],
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ImplementationGuide.definition.template.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"isModifier": false,
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "ImplementationGuide.definition.template.extension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ImplementationGuide.definition.template.modifierExtension",
"requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"isModifier": true,
"short": "Extensions that cannot be ignored even if unrecognized",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "ImplementationGuide.definition.template.modifierExtension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "BackboneElement.modifierExtension"
},
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ImplementationGuide.definition.template.code",
"min": 1,
"definition": "Type of template specified.",
"isModifier": false,
"short": "Type of template specified",
"type": [ {
"code": "code"
} ],
"mustSupport": false,
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/no-binding",
"valueBoolean": true
} ],
"max": "1",
"id": "ImplementationGuide.definition.template.code",
"base": {
"max": "1",
"min": 1,
"path": "ImplementationGuide.definition.template.code"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ImplementationGuide.definition.template.source",
"min": 1,
"definition": "The source location for the template.",
"isModifier": false,
"short": "The source location for the template",
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"max": "1",
"id": "ImplementationGuide.definition.template.source",
"base": {
"max": "1",
"min": 1,
"path": "ImplementationGuide.definition.template.source"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ImplementationGuide.definition.template.scope",
"min": 0,
"definition": "The scope in which the template applies.",
"isModifier": false,
"short": "The scope in which the template applies",
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"max": "1",
"id": "ImplementationGuide.definition.template.scope",
"base": {
"max": "1",
"min": 0,
"path": "ImplementationGuide.definition.template.scope"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children or both",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ImplementationGuide.manifest",
"min": 0,
"definition": "Information about an assembled implementation guide, created by the publication tooling.",
"isModifier": false,
"short": "Information about an assembled IG",
"type": [ {
"code": "BackboneElement"
} ],
"mustSupport": false,
"max": "1",
"id": "ImplementationGuide.manifest",
"base": {
"max": "1",
"min": 0,
"path": "ImplementationGuide.manifest"
},
"isSummary": false
}, {
"path": "ImplementationGuide.manifest.id",
"min": 0,
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"isModifier": false,
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ImplementationGuide.manifest.id",
"condition": [ "ele-1" ],
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ImplementationGuide.manifest.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"isModifier": false,
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "ImplementationGuide.manifest.extension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ImplementationGuide.manifest.modifierExtension",
"requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"isModifier": true,
"short": "Extensions that cannot be ignored even if unrecognized",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "ImplementationGuide.manifest.modifierExtension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "BackboneElement.modifierExtension"
},
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ImplementationGuide.manifest.rendering",
"min": 0,
"definition": "A pointer to official web page, PDF or other rendering of the implementation guide.",
"isModifier": false,
"short": "Location of rendered implementation guide",
"type": [ {
"code": "url"
} ],
"mustSupport": false,
"max": "1",
"id": "ImplementationGuide.manifest.rendering",
"base": {
"max": "1",
"min": 0,
"path": "ImplementationGuide.manifest.rendering"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children or both",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ImplementationGuide.manifest.resource",
"min": 1,
"definition": "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 resource.",
"isModifier": false,
"short": "Resource in the implementation guide",
"type": [ {
"code": "BackboneElement"
} ],
"mustSupport": false,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString": "ManifestResource"
} ],
"max": "*",
"id": "ImplementationGuide.manifest.resource",
"base": {
"max": "*",
"min": 1,
"path": "ImplementationGuide.manifest.resource"
},
"isSummary": true
}, {
"path": "ImplementationGuide.manifest.resource.id",
"min": 0,
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"isModifier": false,
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ImplementationGuide.manifest.resource.id",
"condition": [ "ele-1" ],
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ImplementationGuide.manifest.resource.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"isModifier": false,
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "ImplementationGuide.manifest.resource.extension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ImplementationGuide.manifest.resource.modifierExtension",
"requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"isModifier": true,
"short": "Extensions that cannot be ignored even if unrecognized",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "ImplementationGuide.manifest.resource.modifierExtension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "BackboneElement.modifierExtension"
},
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ImplementationGuide.manifest.resource.reference",
"min": 1,
"definition": "Where this resource is found.",
"isModifier": false,
"short": "Location of the resource",
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Resource" ]
} ],
"mustSupport": false,
"max": "1",
"id": "ImplementationGuide.manifest.resource.reference",
"comment": "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.",
"base": {
"max": "1",
"min": 1,
"path": "ImplementationGuide.manifest.resource.reference"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ImplementationGuide.manifest.resource.isExample",
"min": 0,
"definition": "If true, indicates the resource is an example instance.",
"isModifier": false,
"short": "Is this an example",
"type": [ {
"code": "boolean"
} ],
"mustSupport": false,
"max": "1",
"id": "ImplementationGuide.manifest.resource.isExample",
"base": {
"max": "1",
"min": 0,
"path": "ImplementationGuide.manifest.resource.isExample"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ImplementationGuide.manifest.resource.profile",
"min": 0,
"definition": "If present, indicates profile(s) the instance is valid against.",
"isModifier": false,
"short": "Profile(s) this is an example of",
"type": [ {
"code": "canonical",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/StructureDefinition" ]
} ],
"mustSupport": false,
"max": "*",
"id": "ImplementationGuide.manifest.resource.profile",
"comment": "Examples: \n\n* StructureDefinition -> Any \n* ValueSet -> expansion \n* OperationDefinition -> Parameters \n* Questionnaire -> QuestionnaireResponse.",
"base": {
"max": "*",
"min": 0,
"path": "ImplementationGuide.manifest.resource.profile"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ImplementationGuide.manifest.resource.relativePath",
"min": 0,
"definition": "The relative path for primary page for this resource within the IG.",
"isModifier": false,
"short": "Relative path for page in IG",
"type": [ {
"code": "url"
} ],
"mustSupport": false,
"max": "1",
"id": "ImplementationGuide.manifest.resource.relativePath",
"comment": "Appending 'rendering' + \"/\" + this should resolve to the resource page.",
"base": {
"max": "1",
"min": 0,
"path": "ImplementationGuide.manifest.resource.relativePath"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children or both",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ImplementationGuide.manifest.page",
"requirements": "Allows validation of hyperlinks from a derived IG to this IG without a local copy of the IG.",
"min": 0,
"definition": "Information about a page within the IG.",
"isModifier": false,
"short": "HTML page within the parent IG",
"type": [ {
"code": "BackboneElement"
} ],
"mustSupport": false,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString": "ManifestPage"
} ],
"max": "*",
"id": "ImplementationGuide.manifest.page",
"base": {
"max": "*",
"min": 0,
"path": "ImplementationGuide.manifest.page"
},
"isSummary": false
}, {
"path": "ImplementationGuide.manifest.page.id",
"min": 0,
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"isModifier": false,
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "ImplementationGuide.manifest.page.id",
"condition": [ "ele-1" ],
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ImplementationGuide.manifest.page.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"isModifier": false,
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "ImplementationGuide.manifest.page.extension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ImplementationGuide.manifest.page.modifierExtension",
"requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"isModifier": true,
"short": "Extensions that cannot be ignored even if unrecognized",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "ImplementationGuide.manifest.page.modifierExtension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "BackboneElement.modifierExtension"
},
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ImplementationGuide.manifest.page.name",
"min": 1,
"definition": "Relative path to the page.",
"isModifier": false,
"short": "HTML page name",
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"max": "1",
"id": "ImplementationGuide.manifest.page.name",
"comment": "Appending 'rendering' + \"/\" + this should resolve to the page.",
"base": {
"max": "1",
"min": 1,
"path": "ImplementationGuide.manifest.page.name"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ImplementationGuide.manifest.page.title",
"requirements": "Allows generation of labels for markdown-generated hyperlinks.",
"min": 0,
"definition": "Label for the page intended for human display.",
"isModifier": false,
"short": "Title of the page, for references",
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"max": "1",
"id": "ImplementationGuide.manifest.page.title",
"base": {
"max": "1",
"min": 0,
"path": "ImplementationGuide.manifest.page.title"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ImplementationGuide.manifest.page.anchor",
"requirements": "Allows validation of hyperlinks from a derived IG to this IG without a local copy of the IG.",
"min": 0,
"definition": "The name of an anchor available on the page.",
"isModifier": false,
"short": "Anchor available on the page",
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"max": "*",
"id": "ImplementationGuide.manifest.page.anchor",
"comment": "Appending 'rendering' + \"/\" + page.name + \"#\" + page.anchor should resolve to the anchor.",
"base": {
"max": "*",
"min": 0,
"path": "ImplementationGuide.manifest.page.anchor"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ImplementationGuide.manifest.image",
"requirements": "Allows validation of image links from a derived IG to this IG without a local copy of the IG.",
"min": 0,
"definition": "Indicates a relative path to an image that exists within the IG.",
"isModifier": false,
"short": "Image within the IG",
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"max": "*",
"id": "ImplementationGuide.manifest.image",
"base": {
"max": "*",
"min": 0,
"path": "ImplementationGuide.manifest.image"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ImplementationGuide.manifest.other",
"requirements": "Allows validation of links from a derived IG to this IG without a local copy of the IG.",
"min": 0,
"definition": "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 IG.",
"isModifier": false,
"short": "Additional linkable file in IG",
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"max": "*",
"id": "ImplementationGuide.manifest.other",
"base": {
"max": "*",
"min": 0,
"path": "ImplementationGuide.manifest.other"
},
"isSummary": false
} ]
},
"status": "active",
"id": "a455ae27-6ef3-45b0-83c9-7ab12a9b4c1b",
"kind": "resource",
"url": "http://hl7.org/fhir/StructureDefinition/ImplementationGuide",
"version": "6.0.0-ballot4",
"differential": {
"element": [ {
"constraint": [ {
"key": "cnl-0",
"human": "Name should be usable as an identifier for the module by machine processing applications such as code generation",
"source": "http://hl7.org/fhir/StructureDefinition/ImplementationGuide",
"severity": "warning",
"expression": "name.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$')"
}, {
"key": "ig-2",
"human": "If a resource has a fhirVersion, it must be one of the versions defined for the Implementation Guide",
"source": "http://hl7.org/fhir/StructureDefinition/ImplementationGuide",
"severity": "error",
"expression": "definition.resource.fhirVersion.all(%context.fhirVersion contains $this)"
} ],
"path": "ImplementationGuide",
"min": 0,
"definition": "A set of rules of how a particular interoperability or standards problem is solved - typically through the use of FHIR resources. 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.",
"isModifier": false,
"short": "A set of rules about how FHIR is used",
"mapping": [ {
"map": "conformance.misc",
"identity": "w5"
}, {
"map": "n/a",
"identity": "rim"
} ],
"mustSupport": false,
"max": "*",
"id": "ImplementationGuide"
}, {
"constraint": [ {
"key": "cnl-1",
"human": "URL should not contain | or # - these characters make processing canonical references problematic",
"source": "http://hl7.org/fhir/StructureDefinition/ImplementationGuide",
"severity": "warning",
"expression": "exists() implies matches('^[^|# ]+$')"
} ],
"path": "ImplementationGuide.url",
"requirements": "Allows the implementation guide to be referenced by a single globally unique identifier. This is required to allow hosting Implementation Guides on multiple different servers, and to allow for the editorial process.",
"min": 1,
"definition": "An absolute URI that is used to identify this implementation guide when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this implementation guide is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the implementation guide is stored on different servers.",
"isModifier": false,
"short": "Canonical identifier for this implementation guide, represented as a URI (globally unique)",
"mapping": [ {
"map": "FiveWs.identifier",
"identity": "w5"
} ],
"type": [ {
"code": "uri"
} ],
"mustSupport": false,
"alias": [ "url", "authoritative-url", "destination", "identity" ],
"max": "1",
"id": "ImplementationGuide.url",
"comment": "Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.\n\nThe determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in [Technical and Business Versions](resource.html#versions). \n\nIn some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the [meta.source](resource.html#meta) element to indicate where the current master source of the resource can be found.",
"isSummary": true
}, {
"path": "ImplementationGuide.identifier",
"requirements": "Allows externally provided and/or usable business identifiers to be easily associated with the module.",
"min": 0,
"definition": "A formal identifier that is used to identify this implementation guide when it is represented in other formats, or referenced in a specification, model, design or an instance.",
"isModifier": false,
"short": "Additional identifier for the implementation guide (business identifier)",
"mapping": [ {
"map": "FiveWs.identifier",
"identity": "w5"
} ],
"type": [ {
"code": "Identifier"
} ],
"mustSupport": false,
"max": "*",
"id": "ImplementationGuide.identifier",
"isSummary": true
}, {
"path": "ImplementationGuide.version",
"min": 0,
"definition": "The identifier that is used to identify this version of the implementation guide when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the implementation guide 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 sequence.",
"isModifier": false,
"short": "Business version of the implementation guide",
"mapping": [ {
"map": "FiveWs.version",
"identity": "w5"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"max": "1",
"id": "ImplementationGuide.version",
"comment": "There may be different implementation guide instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the implementation guide with the format [url]|[version]. The version SHOULD NOT contain a '#' - see [Business Version](resource.html#bv-format).",
"isSummary": true
}, {
"path": "ImplementationGuide.versionAlgorithm[x]",
"min": 0,
"definition": "Indicates the mechanism used to compare versions to determine which is more current.",
"isModifier": false,
"short": "How to compare versions",
"type": [ {
"code": "string"
}, {
"code": "Coding"
} ],
"mustSupport": false,
"binding": {
"strength": "extensible",
"valueSet": "http://hl7.org/fhir/ValueSet/version-algorithm"
},
"max": "1",
"id": "ImplementationGuide.versionAlgorithm[x]",
"comment": "If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 and a 0 if the version ordering can't be successfully be determined.",
"isSummary": true
}, {
"path": "ImplementationGuide.name",
"requirements": "Support human navigation and code generation.",
"min": 1,
"definition": "A natural language name identifying the implementation guide. This name should be usable as an identifier for the module by machine processing applications such as code generation.",
"isModifier": false,
"short": "Name for this implementation guide (computer friendly)",
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"max": "1",
"id": "ImplementationGuide.name",
"condition": [ "cnl-0" ],
"comment": "The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.",
"isSummary": true
}, {
"path": "ImplementationGuide.title",
"min": 0,
"definition": "A short, descriptive, user-friendly title for the implementation guide.",
"isModifier": false,
"short": "Name for this implementation guide (human friendly)",
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "ImplementationGuide.title",
"comment": "This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.",
"isSummary": true
}, {
"path": "ImplementationGuide.status",
"min": 1,
"definition": "The status of this implementation guide. Enables tracking the life-cycle of the content.",
"isModifier": true,
"short": "draft | active | retired | unknown",
"mapping": [ {
"map": "FiveWs.status",
"identity": "w5"
} ],
"type": [ {
"code": "code"
} ],
"mustSupport": false,
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/publication-status|6.0.0-ballot4",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "PublicationStatus"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
} ],
"description": "The lifecycle status of an artifact."
},
"max": "1",
"id": "ImplementationGuide.status",
"comment": "Allows filtering of implementation guides that are appropriate for use versus not.\n\nSee guidance around (not) making local changes to elements [here](canonicalresource.html#localization).",
"isModifierReason": "This is labeled as \"Is Modifier\" because applications should not use a retired {{title}} without due consideration",
"isSummary": true
}, {
"path": "ImplementationGuide.experimental",
"requirements": "Enables experimental content to be developed following the same lifecycle that would be used for a production-level implementation guide.",
"min": 0,
"definition": "A Boolean value to indicate that this implementation guide is authored for testing purposes (or education/evaluation/marketing) and no version of this resource will ever be intended for genuine usage.",
"isModifier": false,
"short": "For testing only - never for real usage",
"mapping": [ {
"map": "FiveWs.class",
"identity": "w5"
} ],
"type": [ {
"code": "boolean"
} ],
"mustSupport": false,
"meaningWhenMissing": "If absent, this resource is treated as though it is not experimental.",
"max": "1",
"id": "ImplementationGuide.experimental",
"comment": "Allows filtering of implementation guides that are appropriate for use versus not. Experimental resources might include example instances in implementation guides, instances created solely for testing purposes, etc. If experimental is 'true' for any version of a resource, it should be true for all versions of the resource. (If experimental changes, then it is being misused or a resource that was never intended for real-world use has unexpectedly changed its purpose.).\n\nExperimental resources are not expected to be stable and may well have breaking changes without a corresponding change to the 'version' element.",
"isSummary": true
}, {
"path": "ImplementationGuide.date",
"min": 0,
"definition": "The date (and optionally time) when the implementation guide was last significantly changed. The date must change 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 changes.",
"isModifier": false,
"short": "Date last changed",
"mapping": [ {
"map": "FiveWs.recorded",
"identity": "w5"
} ],
"type": [ {
"code": "dateTime"
} ],
"mustSupport": false,
"alias": [ "Revision Date" ],
"max": "1",
"id": "ImplementationGuide.date",
"comment": "The date is often not tracked until the resource is published, but may be present on draft content. 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 or be found by consulting Provenances associated with past versions of the resource.\n\nSee guidance around (not) making local changes to elements [here](canonicalresource.html#localization).",
"isSummary": true
}, {
"path": "ImplementationGuide.publisher",
"requirements": "Helps establish the \"authority/credibility\" of the implementation guide. May also allow for contact.",
"min": 0,
"definition": "The name of the organization or individual responsible for the release and ongoing maintenance of the implementation guide.",
"isModifier": false,
"short": "Name of the publisher/steward (organization or individual)",
"mapping": [ {
"map": "FiveWs.witness",
"identity": "w5"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "ImplementationGuide.publisher",
"comment": "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.",
"isSummary": true
}, {
"path": "ImplementationGuide.contact",
"min": 0,
"definition": "Contact details to assist a user in finding and communicating with the publisher.",
"isModifier": false,
"short": "Contact details for the publisher",
"type": [ {
"code": "ContactDetail"
} ],
"mustSupport": false,
"max": "*",
"id": "ImplementationGuide.contact",
"comment": "May be a web site, an email address, a telephone number, etc.\n\nSee guidance around (not) making local changes to elements [here](canonicalresource.html#localization).",
"isSummary": true
}, {
"path": "ImplementationGuide.description",
"min": 0,
"definition": "A free text natural language description of the implementation guide from a consumer's perspective.",
"isModifier": false,
"short": "Natural language description of the implementation guide",
"type": [ {
"code": "markdown"
} ],
"mustSupport": false,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "ImplementationGuide.description",
"comment": "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 implementation guide as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the implementation guide is presumed to be the predominant language in the place the implementation guide was created).",
"isSummary": false
}, {
"path": "ImplementationGuide.useContext",
"requirements": "Assist in searching for appropriate content.",
"min": 0,
"definition": "The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate implementation guide instances.",
"isModifier": false,
"short": "The context that the content is intended to support",
"type": [ {
"code": "UsageContext"
} ],
"mustSupport": false,
"max": "*",
"id": "ImplementationGuide.useContext",
"comment": "When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.",
"isSummary": true
}, {
"path": "ImplementationGuide.jurisdiction",
"min": 0,
"definition": "A legal or geographic region in which the authority that maintains the resource is operating. In general, the jurisdiction is also found in the useContext. The useContext may reference additional jurisdictions because the defining jurisdiction does not necessarily limit the jurisdictions of use.",
"isModifier": false,
"short": "Jurisdiction of the authority that maintains the implementation guide (if applicable)",
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": false,
"binding": {
"strength": "extensible",
"valueSet": "http://terminology.hl7.org/ValueSet/jurisdiction",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Jurisdiction"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
} ],
"description": "Countries and regions within which this artifact is targeted for use."
},
"max": "*",
"id": "ImplementationGuide.jurisdiction",
"comment": "It may be possible for the implementation guide to be used in jurisdictions other than those for which it was originally designed or intended.\n\nDEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'jurisdiction' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#jurisdiction and useContext.valueCodeableConcept indicating the jurisdiction.)",
"isSummary": true
}, {
"path": "ImplementationGuide.purpose",
"min": 0,
"definition": "Explanation of why this implementation guide is needed and why it has been designed as it has.",
"isModifier": false,
"short": "Why this implementation guide is defined",
"mapping": [ {
"map": "FiveWs.why[x]",
"identity": "w5"
}, {
"map": "no-gen-base",
"identity": "objimpl"
} ],
"type": [ {
"code": "markdown"
} ],
"mustSupport": false,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "ImplementationGuide.purpose",
"comment": "This element does not describe the usage of the implementation guide. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this implementation guide.",
"isSummary": false
}, {
"path": "ImplementationGuide.copyright",
"requirements": "Consumers must be able to determine any legal restrictions on the use of the implementation guide and/or its content.",
"min": 0,
"definition": "A copyright statement relating to the implementation guide and/or its contents. Copyright statements are notices of intellectual property ownership and can include restrictions on the use and publishing of the implementation guide.",
"isModifier": false,
"short": "Notice about intellectual property ownership, can include restrictions on use",
"mapping": [ {
"map": "no-gen-base",
"identity": "objimpl"
} ],
"type": [ {
"code": "markdown"
} ],
"mustSupport": false,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"alias": [ "License", "Restrictions" ],
"max": "1",
"id": "ImplementationGuide.copyright",
"comment": "...",
"isSummary": false
}, {
"path": "ImplementationGuide.copyrightLabel",
"requirements": "Defines the content expected to be rendered in all representations of the artifact.",
"min": 0,
"definition": "A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are restricted. (e.g. 'All rights reserved', 'Some rights reserved').",
"isModifier": false,
"short": "Copyright holder and year(s)",
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "ImplementationGuide.copyrightLabel",
"comment": "The copyright symbol and the '(c)' textual representation SHOULD NOT be included in this string. It will be added by software when rendering the notation. Full details about licensing, restrictions, warrantees, etc. goes in the more general 'copyright' element.",
"isSummary": false
}, {
"path": "ImplementationGuide.packageId",
"min": 1,
"definition": "The NPM package name for this Implementation Guide, used in the NPM package distribution, which is the primary mechanism by which FHIR based tooling manages IG dependencies. This value must be globally unique, and should be assigned with care.",
"isModifier": false,
"short": "NPM Package name for IG",
"type": [ {
"code": "id"
} ],
"mustSupport": false,
"max": "1",
"id": "ImplementationGuide.packageId",
"comment": "Many (if not all) IG publishing tools will require that this element be present. For implementation guides published through HL7 or the FHIR foundation, the FHIR product director assigns package IDs.",
"isSummary": true
}, {
"path": "ImplementationGuide.license",
"min": 0,
"definition": "The license that applies to this Implementation Guide, using an SPDX license code, or 'not-open-source'.",
"isModifier": false,
"short": "SPDX license code for this IG (or not-open-source)",
"type": [ {
"code": "code"
} ],
"mustSupport": false,
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/spdx-license|6.0.0-ballot4",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "SPDXLicense"
} ],
"description": "The license that applies to an Implementation Guide (using an SPDX license Identifiers, or 'not-open-source'). The binding is required but new SPDX license Identifiers are allowed to be used (https://spdx.org/licenses/)."
},
"max": "1",
"id": "ImplementationGuide.license",
"isSummary": true
}, {
"path": "ImplementationGuide.fhirVersion",
"min": 1,
"definition": "The version(s) of the FHIR specification that this ImplementationGuide targets - e.g. describes how to use. The value of this element is the formal version of the specification, without the revision number, e.g. [publication].[major].[minor], which is 4.6.0. for this version.",
"isModifier": false,
"short": "FHIR Version(s) this Implementation Guide targets",
"type": [ {
"code": "code"
} ],
"mustSupport": false,
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/FHIR-version|6.0.0-ballot4",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "FHIRVersion"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
} ],
"description": "All published FHIR Versions."
},
"max": "*",
"id": "ImplementationGuide.fhirVersion",
"condition": [ "ig-2" ],
"comment": "Most implementation guides target a single version - e.g. they describe how to use a particular version, and the profiles and examples etc. are valid for that version. But some implementation guides describe how to use multiple different versions of FHIR to solve the same problem, or in concert with each other. Typically, the requirement to support multiple versions arises as implementation matures and different implementation communities are stuck at different versions by regulation or market dynamics.",
"isSummary": true
}, {
"path": "ImplementationGuide.dependsOn",
"min": 0,
"definition": "Another implementation guide that this implementation depends on. Typically, an implementation guide uses value sets, profiles etc.defined in other implementation guides.",
"isModifier": false,
"short": "Another Implementation guide this depends on",
"type": [ {
"code": "BackboneElement"
} ],
"mustSupport": false,
"max": "*",
"id": "ImplementationGuide.dependsOn",
"isSummary": true
}, {
"path": "ImplementationGuide.dependsOn.uri",
"min": 1,
"definition": "A canonical reference to the Implementation guide for the dependency.",
"isModifier": false,
"short": "Identity of the IG that this depends on",
"type": [ {
"code": "canonical",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/ImplementationGuide" ]
} ],
"mustSupport": false,
"max": "1",
"id": "ImplementationGuide.dependsOn.uri",
"comment": "Usually, A canonical reference to the implementation guide is the same as the master location at which the implementation guide is published.",
"isSummary": true
}, {
"path": "ImplementationGuide.dependsOn.packageId",
"min": 0,
"definition": "The NPM package name for the Implementation Guide that this IG depends on.",
"isModifier": false,
"short": "NPM Package name for IG this depends on",
"type": [ {
"code": "id"
} ],
"mustSupport": false,
"max": "1",
"id": "ImplementationGuide.dependsOn.packageId",
"isSummary": true
}, {
"path": "ImplementationGuide.dependsOn.version",
"min": 0,
"definition": "The version of the IG that is depended on, when the correct version is required to understand the IG correctly.",
"isModifier": false,
"short": "Version of the IG",
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"max": "1",
"id": "ImplementationGuide.dependsOn.version",
"comment": "This follows the syntax of the NPM packaging version field - see [[reference]].",
"isSummary": true
}, {
"path": "ImplementationGuide.dependsOn.reason",
"min": 0,
"definition": "A description explaining the nature of the dependency on the listed IG.",
"isModifier": false,
"short": "Why dependency exists",
"type": [ {
"code": "markdown"
} ],
"mustSupport": false,
"max": "1",
"id": "ImplementationGuide.dependsOn.reason",
"comment": "This doesn't need to enumerate every resource used, but should give some sense of why the dependency exists. It will be used in the rendered list of dependencies",
"isSummary": false
}, {
"path": "ImplementationGuide.global",
"min": 0,
"definition": "A set of profiles that all resources covered by this implementation guide must conform to.",
"isModifier": false,
"short": "Profiles that apply globally",
"type": [ {
"code": "BackboneElement"
} ],
"mustSupport": false,
"max": "*",
"id": "ImplementationGuide.global",
"comment": "See [Default Profiles](implementationguide.html#default) for a discussion of which resources are 'covered' by an implementation guide.",
"isSummary": true
}, {
"path": "ImplementationGuide.global.type",
"min": 1,
"definition": "The type of resource that all instances must conform to.",
"isModifier": false,
"short": "Type this profile applies to",
"type": [ {
"code": "code"
} ],
"mustSupport": false,
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/resource-types|6.0.0-ballot4",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ResourceType"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
} ],
"description": "One of the resource types defined as part of this version of FHIR."
},
"max": "1",
"id": "ImplementationGuide.global.type",
"comment": "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.",
"isSummary": true
}, {
"path": "ImplementationGuide.global.profile",
"min": 1,
"definition": "A reference to the profile that all instances must conform to.",
"isModifier": false,
"short": "Profile that all resources must conform to",
"type": [ {
"code": "canonical",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/StructureDefinition" ]
} ],
"mustSupport": false,
"max": "1",
"id": "ImplementationGuide.global.profile",
"isSummary": true
}, {
"constraint": [ {
"key": "ig-1",
"human": "If a resource has a groupingId, it must refer to a grouping defined in the Implementation Guide",
"source": "http://hl7.org/fhir/StructureDefinition/ImplementationGuide",
"severity": "error",
"expression": "resource.groupingId.all(%context.grouping.id contains $this)"
} ],
"path": "ImplementationGuide.definition",
"min": 0,
"definition": "The information needed by an IG publisher tool to publish the whole implementation guide.",
"isModifier": false,
"short": "Information needed to build the IG",
"type": [ {
"code": "BackboneElement"
} ],
"mustSupport": false,
"max": "1",
"id": "ImplementationGuide.definition",
"condition": [ "ig-2" ],
"comment": "Principally, this consists of information abuot source resource and file locations, and build parameters and templates.",
"isSummary": false
}, {
"path": "ImplementationGuide.definition.grouping",
"min": 0,
"definition": "A logical group of resources. Logical groups can be used when building pages.",
"isModifier": false,
"short": "Grouping used to present related resources in the IG",
"type": [ {
"code": "BackboneElement"
} ],
"mustSupport": false,
"max": "*",
"id": "ImplementationGuide.definition.grouping",
"condition": [ "ig-1" ],
"comment": "Groupings are arbitrary sub-divisions of content. Typically, they are used to help build Table of Contents automatically.",
"isSummary": false
}, {
"path": "ImplementationGuide.definition.grouping.name",
"min": 1,
"definition": "The human-readable title to display for the package of resources when rendering the implementation guide.",
"isModifier": false,
"short": "Descriptive name for the package",
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "ImplementationGuide.definition.grouping.name",
"isSummary": false
}, {
"path": "ImplementationGuide.definition.grouping.description",
"min": 0,
"definition": "Human readable text describing the package.",
"isModifier": false,
"short": "Human readable text describing the package",
"type": [ {
"code": "markdown"
} ],
"mustSupport": false,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "ImplementationGuide.definition.grouping.description",
"isSummary": false
}, {
"path": "ImplementationGuide.definition.resource",
"min": 0,
"definition": "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 resource.",
"isModifier": false,
"short": "Resource in the implementation guide",
"type": [ {
"code": "BackboneElement"
} ],
"mustSupport": false,
"max": "*",
"id": "ImplementationGuide.definition.resource",
"condition": [ "ig-2", "ig-1" ],
"isSummary": false
}, {
"path": "ImplementationGuide.definition.resource.reference",
"min": 1,
"definition": "Where this resource is found.",
"isModifier": false,
"short": "Location of the resource",
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Resource" ]
} ],
"mustSupport": false,
"max": "1",
"id": "ImplementationGuide.definition.resource.reference",
"comment": "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": false
}, {
"path": "ImplementationGuide.definition.resource.fhirVersion",
"min": 0,
"definition": "Indicates the FHIR Version(s) this artifact is intended to apply to. If no versions are specified, the resource is assumed to apply to all the versions stated in ImplementationGuide.fhirVersion.",
"isModifier": false,
"short": "Versions this applies to (if different to IG)",
"type": [ {
"code": "code"
} ],
"mustSupport": false,
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/FHIR-version|6.0.0-ballot4",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "FHIRVersion"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
} ],
"description": "All published FHIR Versions."
},
"max": "*",
"id": "ImplementationGuide.definition.resource.fhirVersion",
"condition": [ "ig-2" ],
"comment": "The resource SHALL be valid against all the versions it is specified to apply to. If the resource referred to is a StructureDefinition, the fhirVersion stated in the StructureDefinition cannot disagree with the version specified here; the specified versions SHALL include the version specified by the StructureDefinition, and may include additional versions using the [http://hl7.org/fhir/StructureDefinition/structuredefinition-applicable-version](https://build.fhir.org/ig/HL7/fhir-extensions/StructureDefinition-structuredefinition-applicable-version.html) extension.",
"isSummary": false
}, {
"path": "ImplementationGuide.definition.resource.name",
"min": 0,
"definition": "A human assigned name for the resource. All resources SHOULD have a name, but the name may be extracted from the resource (e.g. ValueSet.name).",
"isModifier": false,
"short": "Human readable name for the resource",
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "ImplementationGuide.definition.resource.name",
"isSummary": false
}, {
"path": "ImplementationGuide.definition.resource.description",
"min": 0,
"definition": "A description of the reason that a resource has been included in the implementation guide.",
"isModifier": false,
"short": "Reason why included in guide",
"type": [ {
"code": "markdown"
} ],
"mustSupport": false,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "ImplementationGuide.definition.resource.description",
"comment": "This is mostly used with examples to explain why it is present (though they can have extensive comments in the examples).",
"isSummary": false
}, {
"path": "ImplementationGuide.definition.resource.isExample",
"min": 0,
"definition": "If true, indicates the resource is an example instance.",
"isModifier": false,
"short": "Is this an example",
"type": [ {
"code": "boolean"
} ],
"mustSupport": false,
"max": "1",
"id": "ImplementationGuide.definition.resource.isExample",
"isSummary": false
}, {
"path": "ImplementationGuide.definition.resource.profile",
"min": 0,
"definition": "If present, indicates profile(s) the instance is valid against.",
"isModifier": false,
"short": "Profile(s) this resource is valid against",
"type": [ {
"code": "canonical",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/StructureDefinition" ]
} ],
"mustSupport": false,
"max": "*",
"id": "ImplementationGuide.definition.resource.profile",
"comment": "This can be used for both example and non-example resources to indicate profiles they are expected to be valid against. E.g. a non-example ValueSet might be declared to be a valid 'ShareableValueSet'",
"isSummary": false
}, {
"path": "ImplementationGuide.definition.resource.groupingId",
"min": 0,
"definition": "Reference to the id of the grouping this resource appears in.",
"isModifier": false,
"short": "Grouping this is part of",
"type": [ {
"code": "id"
} ],
"mustSupport": false,
"max": "1",
"id": "ImplementationGuide.definition.resource.groupingId",
"condition": [ "ig-1" ],
"comment": "This must correspond to a group.id element within this implementation guide.",
"isSummary": false
}, {
"constraint": [ {
"key": "ig-3",
"human": "Source must be absent if 'generated' is generated",
"source": "http://hl7.org/fhir/StructureDefinition/ImplementationGuide",
"severity": "error",
"expression": "generation='generated' implies source.empty()"
} ],
"path": "ImplementationGuide.definition.page",
"min": 0,
"definition": "A page / section in the implementation guide. The root page is the implementation guide home page.",
"isModifier": false,
"short": "Page/Section in the Guide",
"type": [ {
"code": "BackboneElement"
} ],
"mustSupport": false,
"max": "1",
"id": "ImplementationGuide.definition.page",
"comment": "Pages automatically become sections if they have sub-pages. By convention, the home page is called index.html.",
"isSummary": false
}, {
"path": "ImplementationGuide.definition.page.source[x]",
"min": 0,
"definition": "Indicates the URL or the actual content to provide for the page.",
"isModifier": false,
"short": "Source for page",
"type": [ {
"code": "url"
}, {
"code": "string"
}, {
"code": "markdown"
} ],
"mustSupport": false,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "ImplementationGuide.definition.page.source[x]",
"condition": [ "ig-3" ],
"comment": "If absent and the page isn't a generated page, this may be inferred from the page name by checking input locations. String is used for XHTML content - sent as an escaped string. FHIR tooling can't support 'direct' XHTML anywhere other than in narrative.",
"isSummary": false
}, {
"path": "ImplementationGuide.definition.page.name",
"min": 1,
"definition": "The url by which the page should be known when published.",
"isModifier": false,
"short": "Name of the page when published",
"type": [ {
"code": "url"
} ],
"mustSupport": false,
"max": "1",
"id": "ImplementationGuide.definition.page.name",
"comment": "This SHALL be a local reference, expressed with respect to the root of the IG output folder. No suffix is required. If no suffix is specified, .html will be appended.",
"isSummary": false
}, {
"path": "ImplementationGuide.definition.page.title",
"min": 1,
"definition": "A short title used to represent this page in navigational structures such as table of contents, bread crumbs, etc.",
"isModifier": false,
"short": "Short title shown for navigational assistance",
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "ImplementationGuide.definition.page.title",
"isSummary": false
}, {
"path": "ImplementationGuide.definition.page.generation",
"min": 1,
"definition": "A code that indicates how the page is generated.",
"isModifier": false,
"short": "html | markdown | xml | generated",
"type": [ {
"code": "code"
} ],
"mustSupport": false,
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/guide-page-generation|6.0.0-ballot4",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "GuidePageGeneration"
} ],
"description": "A code that indicates how the page is generated."
},
"max": "1",
"id": "ImplementationGuide.definition.page.generation",
"condition": [ "ig-3" ],
"isSummary": false
}, {
"path": "ImplementationGuide.definition.page.page",
"min": 0,
"definition": "Nested Pages/Sections under this page.",
"isModifier": false,
"short": "Nested Pages / Sections",
"contentReference": "#ImplementationGuide.definition.page",
"mustSupport": false,
"max": "*",
"id": "ImplementationGuide.definition.page.page",
"comment": "The implementation guide breadcrumbs may be generated from this structure.",
"isSummary": false
}, {
"path": "ImplementationGuide.definition.parameter",
"min": 0,
"definition": "A set of parameters that defines how the implementation guide is built. The parameters are defined by the relevant tools that build the implementation guides.",
"isModifier": false,
"short": "Defines how IG is built by tools",
"type": [ {
"code": "BackboneElement"
} ],
"mustSupport": false,
"max": "*",
"id": "ImplementationGuide.definition.parameter",
"comment": "see [confluence](https://confluence.hl7.org/display/FHIR/Implementation+Guide+Parameters) for the parameters defined by the HL7 IG publisher.",
"isSummary": false
}, {
"path": "ImplementationGuide.definition.parameter.code",
"min": 1,
"definition": "A tool-specific code that defines the parameter.",
"isModifier": false,
"short": "Code that identifies parameter",
"type": [ {
"code": "Coding"
} ],
"mustSupport": false,
"binding": {
"strength": "extensible",
"valueSet": "http://hl7.org/fhir/ValueSet/guide-parameter-code"
},
"max": "1",
"id": "ImplementationGuide.definition.parameter.code",
"isSummary": false
}, {
"path": "ImplementationGuide.definition.parameter.value",
"min": 1,
"definition": "Value for named type.",
"isModifier": false,
"short": "Value for named type",
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"max": "1",
"id": "ImplementationGuide.definition.parameter.value",
"isSummary": false
}, {
"path": "ImplementationGuide.definition.template",
"min": 0,
"definition": "A template for building resources.",
"isModifier": false,
"short": "A template for building resources",
"type": [ {
"code": "BackboneElement"
} ],
"mustSupport": false,
"max": "*",
"id": "ImplementationGuide.definition.template",
"isSummary": false
}, {
"path": "ImplementationGuide.definition.template.code",
"min": 1,
"definition": "Type of template specified.",
"isModifier": false,
"short": "Type of template specified",
"type": [ {
"code": "code"
} ],
"mustSupport": false,
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/no-binding",
"valueBoolean": true
} ],
"max": "1",
"id": "ImplementationGuide.definition.template.code",
"isSummary": false
}, {
"path": "ImplementationGuide.definition.template.source",
"min": 1,
"definition": "The source location for the template.",
"isModifier": false,
"short": "The source location for the template",
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"max": "1",
"id": "ImplementationGuide.definition.template.source",
"isSummary": false
}, {
"path": "ImplementationGuide.definition.template.scope",
"min": 0,
"definition": "The scope in which the template applies.",
"isModifier": false,
"short": "The scope in which the template applies",
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"max": "1",
"id": "ImplementationGuide.definition.template.scope",
"isSummary": false
}, {
"path": "ImplementationGuide.manifest",
"min": 0,
"definition": "Information about an assembled implementation guide, created by the publication tooling.",
"isModifier": false,
"short": "Information about an assembled IG",
"type": [ {
"code": "BackboneElement"
} ],
"mustSupport": false,
"max": "1",
"id": "ImplementationGuide.manifest",
"isSummary": false
}, {
"path": "ImplementationGuide.manifest.rendering",
"min": 0,
"definition": "A pointer to official web page, PDF or other rendering of the implementation guide.",
"isModifier": false,
"short": "Location of rendered implementation guide",
"type": [ {
"code": "url"
} ],
"mustSupport": false,
"max": "1",
"id": "ImplementationGuide.manifest.rendering",
"isSummary": true
}, {
"path": "ImplementationGuide.manifest.resource",
"min": 1,
"definition": "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 resource.",
"isModifier": false,
"short": "Resource in the implementation guide",
"type": [ {
"code": "BackboneElement"
} ],
"mustSupport": false,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString": "ManifestResource"
} ],
"max": "*",
"id": "ImplementationGuide.manifest.resource",
"isSummary": true
}, {
"path": "ImplementationGuide.manifest.resource.reference",
"min": 1,
"definition": "Where this resource is found.",
"isModifier": false,
"short": "Location of the resource",
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Resource" ]
} ],
"mustSupport": false,
"max": "1",
"id": "ImplementationGuide.manifest.resource.reference",
"comment": "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
}, {
"path": "ImplementationGuide.manifest.resource.isExample",
"min": 0,
"definition": "If true, indicates the resource is an example instance.",
"isModifier": false,
"short": "Is this an example",
"type": [ {
"code": "boolean"
} ],
"mustSupport": false,
"max": "1",
"id": "ImplementationGuide.manifest.resource.isExample",
"isSummary": false
}, {
"path": "ImplementationGuide.manifest.resource.profile",
"min": 0,
"definition": "If present, indicates profile(s) the instance is valid against.",
"isModifier": false,
"short": "Profile(s) this is an example of",
"type": [ {
"code": "canonical",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/StructureDefinition" ]
} ],
"mustSupport": false,
"max": "*",
"id": "ImplementationGuide.manifest.resource.profile",
"comment": "Examples: \n\n* StructureDefinition -> Any \n* ValueSet -> expansion \n* OperationDefinition -> Parameters \n* Questionnaire -> QuestionnaireResponse.",
"isSummary": false
}, {
"path": "ImplementationGuide.manifest.resource.relativePath",
"min": 0,
"definition": "The relative path for primary page for this resource within the IG.",
"isModifier": false,
"short": "Relative path for page in IG",
"type": [ {
"code": "url"
} ],
"mustSupport": false,
"max": "1",
"id": "ImplementationGuide.manifest.resource.relativePath",
"comment": "Appending 'rendering' + \"/\" + this should resolve to the resource page.",
"isSummary": false
}, {
"path": "ImplementationGuide.manifest.page",
"requirements": "Allows validation of hyperlinks from a derived IG to this IG without a local copy of the IG.",
"min": 0,
"definition": "Information about a page within the IG.",
"isModifier": false,
"short": "HTML page within the parent IG",
"type": [ {
"code": "BackboneElement"
} ],
"mustSupport": false,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString": "ManifestPage"
} ],
"max": "*",
"id": "ImplementationGuide.manifest.page",
"isSummary": false
}, {
"path": "ImplementationGuide.manifest.page.name",
"min": 1,
"definition": "Relative path to the page.",
"isModifier": false,
"short": "HTML page name",
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"max": "1",
"id": "ImplementationGuide.manifest.page.name",
"comment": "Appending 'rendering' + \"/\" + this should resolve to the page.",
"isSummary": false
}, {
"path": "ImplementationGuide.manifest.page.title",
"requirements": "Allows generation of labels for markdown-generated hyperlinks.",
"min": 0,
"definition": "Label for the page intended for human display.",
"isModifier": false,
"short": "Title of the page, for references",
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"max": "1",
"id": "ImplementationGuide.manifest.page.title",
"isSummary": false
}, {
"path": "ImplementationGuide.manifest.page.anchor",
"requirements": "Allows validation of hyperlinks from a derived IG to this IG without a local copy of the IG.",
"min": 0,
"definition": "The name of an anchor available on the page.",
"isModifier": false,
"short": "Anchor available on the page",
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"max": "*",
"id": "ImplementationGuide.manifest.page.anchor",
"comment": "Appending 'rendering' + \"/\" + page.name + \"#\" + page.anchor should resolve to the anchor.",
"isSummary": false
}, {
"path": "ImplementationGuide.manifest.image",
"requirements": "Allows validation of image links from a derived IG to this IG without a local copy of the IG.",
"min": 0,
"definition": "Indicates a relative path to an image that exists within the IG.",
"isModifier": false,
"short": "Image within the IG",
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"max": "*",
"id": "ImplementationGuide.manifest.image",
"isSummary": false
}, {
"path": "ImplementationGuide.manifest.other",
"requirements": "Allows validation of links from a derived IG to this IG without a local copy of the IG.",
"min": 0,
"definition": "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 IG.",
"isModifier": false,
"short": "Additional linkable file in IG",
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"max": "*",
"id": "ImplementationGuide.manifest.other",
"isSummary": false
} ]
},
"contact": [ {
"telecom": [ {
"value": "http://www.hl7.org/Special/committees/fiwg",
"system": "url"
} ]
} ],
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/DomainResource"
}