This page is part of the FHIR Specification (v4.2.0: R5 Preview #1). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3 R2
FHIR Infrastructure Work Group | Maturity Level: N/A | Standards Status: Informative | Compartments: Not linked to any defined compartments |
Raw JSON (canonical form + also see JSON Format Specification)
StructureDefinition for implementationguide
{ "resourceType" : "StructureDefinition", "id" : "ImplementationGuide", "meta" : { "lastUpdated" : "2019-12-31T21:03:40.621+11:00" }, "text" : { "status" : "generated", "div" : "<div>!-- Snipped for Brevity --></div>" }, "extension" : [{ "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status", "valueCode" : "trial-use" }, { "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm", "valueInteger" : 1 }, { "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category", "valueCode" : "anonymous" }, { "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg", "valueCode" : "fhir" }], "url" : "http://hl7.org/fhir/StructureDefinition/ImplementationGuide", "version" : "4.2.0", "name" : "ImplementationGuide", "status" : "draft", "date" : "2019-12-31T21:03:40+11:00", "publisher" : "Health Level Seven International (FHIR Infrastructure)", "contact" : [{ "telecom" : [{ "system" : "url", "value" : "http://hl7.org/fhir" }] }, { "telecom" : [{ "system" : "url", "value" : "http://www.hl7.org/Special/committees/fiwg/index.cfm" }] }], "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.", "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.", "fhirVersion" : "4.2.0", "mapping" : [{ "identity" : "rim", "uri" : "http://hl7.org/v3", "name" : "RIM Mapping" }, { "identity" : "workflow", "uri" : "http://hl7.org/fhir/workflow", "name" : "Workflow Pattern" }, { "identity" : "w5", "uri" : "http://hl7.org/fhir/fivews", "name" : "FiveWs Pattern Mapping" }, { "identity" : "objimpl", "uri" : "http://hl7.org/fhir/object-implementation", "name" : "Object Implementation Information" }], "kind" : "resource", "abstract" : false, "type" : "ImplementationGuide", "baseDefinition" : "http://hl7.org/fhir/StructureDefinition/CanonicalResource", "derivation" : "specialization", "snapshot" : { "element" : [{ "id" : "ImplementationGuide", "path" : "ImplementationGuide", "short" : "A set of rules about how FHIR is used", "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.", "min" : 0, "max" : "*", "base" : { "path" : "ImplementationGuide", "min" : 0, "max" : "*" }, "constraint" : [{ "key" : "cnl-0", "severity" : "warning", "human" : "Name should be usable as an identifier for the module by machine processing applications such as code generation", "expression" : "name.matches('[A-Z]([A-Za-z0-9_]){0,254}')", "xpath" : "not(exists(f:name/@value)) or matches(f:name/@value, '[A-Z]([A-Za-z0-9_]){0,254}')" }, { "key" : "ig-2", "severity" : "error", "human" : "If a resource has a fhirVersion, it must be oe of the versions defined for the Implementation Guide", "expression" : "definition.resource.fhirVersion.all(%context.fhirVersion contains $this)", "xpath" : "count(for $id in (f:resource/f:fhirVersion) return $id[not(ancestor::f:fhirVersion/@value=$id/@value)])=0" }], "isModifier" : false, "isSummary" : false, "mapping" : [{ "identity" : "workflow", "map" : "Definition" }, { "identity" : "rim", "map" : "n/a" }] }, { "id" : "ImplementationGuide.id", "path" : "ImplementationGuide.id", "short" : "Logical id of this artifact", "definition" : "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", "comment" : "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.", "min" : 0, "max" : "1", "base" : { "path" : "Resource.id", "min" : 0, "max" : "1" }, "type" : [{ "extension" : [{ "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUri" : "id" }], "code" : "http://hl7.org/fhirpath/System.String" }], "isModifier" : false, "isSummary" : true }, { "id" : "ImplementationGuide.meta", "path" : "ImplementationGuide.meta", "short" : "Metadata about the resource", "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.", "min" : 0, "max" : "1", "base" : { "path" : "Resource.meta", "min" : 0, "max" : "1" }, "type" : [{ "code" : "Meta" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "Element" }], "isModifier" : false, "isSummary" : true }, { "id" : "ImplementationGuide.implicitRules", "path" : "ImplementationGuide.implicitRules", "short" : "A set of rules under which this content was created", "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.", "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 it's narrative along with other profiles, value sets, etc.", "min" : 0, "max" : "1", "base" : { "path" : "Resource.implicitRules", "min" : 0, "max" : "1" }, "type" : [{ "code" : "uri" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "Element" }], "isModifier" : true, "isModifierReason" : "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation", "isSummary" : true }, { "id" : "ImplementationGuide.language", "path" : "ImplementationGuide.language", "short" : "Language of the resource content", "definition" : "The base language in which the resource is written.", "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).", "min" : 0, "max" : "1", "base" : { "path" : "Resource.language", "min" : 0, "max" : "1" }, "type" : [{ "code" : "code" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "Element" }], "isModifier" : false, "isSummary" : false, "binding" : { "extension" : [{ "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet", "valueCanonical" : "http://hl7.org/fhir/ValueSet/all-languages" }, { "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString" : "Language" }, { "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding", "valueBoolean" : true }], "strength" : "preferred", "description" : "A human language.", "valueSet" : "http://hl7.org/fhir/ValueSet/languages" } }, { "id" : "ImplementationGuide.text", "path" : "ImplementationGuide.text", "short" : "Text summary of the resource, for human interpretation", "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.", "comment" : "Contained resources do not have 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.", "alias" : ["narrative", "html", "xhtml", "display"], "min" : 0, "max" : "1", "base" : { "path" : "DomainResource.text", "min" : 0, "max" : "1" }, "type" : [{ "code" : "Narrative" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "Element" }], "isModifier" : false, "isSummary" : false, "mapping" : [{ "identity" : "rim", "map" : "Act.text?" }] }, { "id" : "ImplementationGuide.contained", "path" : "ImplementationGuide.contained", "short" : "Contained, inline Resources", "definition" : "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.", "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.", "alias" : ["inline resources", "anonymous resources", "contained resources"], "min" : 0, "max" : "*", "base" : { "path" : "DomainResource.contained", "min" : 0, "max" : "*" }, "type" : [{ "code" : "Resource" }], "isModifier" : false, "isSummary" : false, "mapping" : [{ "identity" : "rim", "map" : "N/A" }] }, { "id" : "ImplementationGuide.extension", "path" : "ImplementationGuide.extension", "short" : "Additional content defined by implementations", "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 manageable, 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.", "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.", "alias" : ["extensions", "user content"], "min" : 0, "max" : "*", "base" : { "path" : "DomainResource.extension", "min" : 0, "max" : "*" }, "type" : [{ "code" : "Extension" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "Element" }, { "key" : "ext-1", "severity" : "error", "human" : "Must have either extensions or value[x], not both", "expression" : "extension.exists() != value.exists()", "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", "source" : "Extension" }], "isModifier" : false, "isSummary" : false, "mapping" : [{ "identity" : "rim", "map" : "N/A" }] }, { "id" : "ImplementationGuide.modifierExtension", "path" : "ImplementationGuide.modifierExtension", "short" : "Extensions that cannot be ignored", "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 manageable, 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).", "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.", "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).", "alias" : ["extensions", "user content"], "min" : 0, "max" : "*", "base" : { "path" : "DomainResource.modifierExtension", "min" : 0, "max" : "*" }, "type" : [{ "code" : "Extension" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "Element" }, { "key" : "ext-1", "severity" : "error", "human" : "Must have either extensions or value[x], not both", "expression" : "extension.exists() != value.exists()", "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", "source" : "Extension" }], "isModifier" : true, "isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them", "isSummary" : false, "mapping" : [{ "identity" : "rim", "map" : "N/A" }] }, { "id" : "ImplementationGuide.url", "path" : "ImplementationGuide.url", "short" : "Canonical identifier for this implementation guide, represented as a URI (globally unique)", "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 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.", "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.", "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.", "alias" : ["url", "authoritative-url", "destination", "identity"], "min" : 1, "max" : "1", "base" : { "path" : "ImplementationGuide.url", "min" : 1, "max" : "1" }, "type" : [{ "code" : "uri" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "Element" }], "isModifier" : false, "isSummary" : true, "mapping" : [{ "identity" : "workflow", "map" : "Definition.url" }, { "identity" : "w5", "map" : "FiveWs.identifier" }] }, { "id" : "ImplementationGuide.version", "path" : "ImplementationGuide.version", "short" : "Business version of the implementation guide", "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.", "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].", "min" : 0, "max" : "1", "base" : { "path" : "ImplementationGuide.version", "min" : 0, "max" : "1" }, "type" : [{ "code" : "string" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "Element" }], "isModifier" : false, "isSummary" : true, "mapping" : [{ "identity" : "workflow", "map" : "Definition.version" }, { "identity" : "w5", "map" : "FiveWs.version" }] }, { "id" : "ImplementationGuide.name", "path" : "ImplementationGuide.name", "short" : "Name for this implementation guide (computer friendly)", "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.", "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.", "requirements" : "Support human navigation and code generation.", "min" : 1, "max" : "1", "base" : { "path" : "ImplementationGuide.name", "min" : 1, "max" : "1" }, "type" : [{ "code" : "string" }], "condition" : ["cnl-0"], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "Element" }], "isModifier" : false, "isSummary" : true }, { "id" : "ImplementationGuide.title", "path" : "ImplementationGuide.title", "short" : "Name for this implementation guide (human friendly)", "definition" : "A short, descriptive, user-friendly title for the implementation guide.", "comment" : "This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.", "min" : 0, "max" : "1", "base" : { "path" : "ImplementationGuide.title", "min" : 0, "max" : "1" }, "type" : [{ "code" : "string" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "Element" }], "isModifier" : false, "isSummary" : true, "mapping" : [{ "identity" : "workflow", "map" : "Definition.title" }] }, { "id" : "ImplementationGuide.status", "path" : "ImplementationGuide.status", "short" : "draft | active | retired | unknown", "definition" : "The status of this implementation guide. Enables tracking the life-cycle of the content.", "comment" : "Allows filtering of implementation guides that are appropriate for use versus not.", "min" : 1, "max" : "1", "base" : { "path" : "ImplementationGuide.status", "min" : 1, "max" : "1" }, "type" : [{ "code" : "code" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "Element" }], "isModifier" : true, "isModifierReason" : "This is labeled as \"Is Modifier\" because applications should not use a retired {{title}} without due consideration", "isSummary" : true, "binding" : { "extension" : [{ "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString" : "PublicationStatus" }, { "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding", "valueBoolean" : true }], "strength" : "required", "description" : "The lifecycle status of an artifact.", "valueSet" : "http://hl7.org/fhir/ValueSet/publication-status|4.2.0" }, "mapping" : [{ "identity" : "workflow", "map" : "Definition.status" }, { "identity" : "w5", "map" : "FiveWs.status" }] }, { "id" : "ImplementationGuide.experimental", "path" : "ImplementationGuide.experimental", "short" : "For testing purposes, not real usage", "definition" : "A Boolean value to indicate that this implementation guide is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.", "comment" : "Allows filtering of implementation guides that are appropriate for use versus not.", "requirements" : "Enables experimental content to be developed following the same lifecycle that would be used for a production-level implementation guide.", "min" : 0, "max" : "1", "base" : { "path" : "ImplementationGuide.experimental", "min" : 0, "max" : "1" }, "type" : [{ "code" : "boolean" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "Element" }], "isModifier" : false, "isSummary" : true, "mapping" : [{ "identity" : "workflow", "map" : "Definition.experimental" }, { "identity" : "w5", "map" : "FiveWs.class" }] }, { "id" : "ImplementationGuide.date", "path" : "ImplementationGuide.date", "short" : "Date last changed", "definition" : "The date (and optionally time) when the implementation guide was published. 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.", "comment" : "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.", "alias" : ["Revision Date"], "min" : 0, "max" : "1", "base" : { "path" : "ImplementationGuide.date", "min" : 0, "max" : "1" }, "type" : [{ "code" : "dateTime" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "Element" }], "isModifier" : false, "isSummary" : true, "mapping" : [{ "identity" : "workflow", "map" : "Definition.date" }, { "identity" : "w5", "map" : "FiveWs.recorded" }] }, { "id" : "ImplementationGuide.publisher", "path" : "ImplementationGuide.publisher", "short" : "Name of the publisher (organization or individual)", "definition" : "The name of the organization or individual that published the implementation guide.", "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.", "requirements" : "Helps establish the \"authority/credibility\" of the implementation guide. May also allow for contact.", "min" : 0, "max" : "1", "base" : { "path" : "ImplementationGuide.publisher", "min" : 0, "max" : "1" }, "type" : [{ "code" : "string" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "Element" }], "isModifier" : false, "isSummary" : true, "mapping" : [{ "identity" : "workflow", "map" : "Definition.publisher" }, { "identity" : "w5", "map" : "FiveWs.witness" }] }, { "id" : "ImplementationGuide.contact", "path" : "ImplementationGuide.contact", "short" : "Contact details for the publisher", "definition" : "Contact details to assist a user in finding and communicating with the publisher.", "comment" : "May be a web site, an email address, a telephone number, etc.", "min" : 0, "max" : "*", "base" : { "path" : "ImplementationGuide.contact", "min" : 0, "max" : "*" }, "type" : [{ "code" : "ContactDetail" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "Element" }], "isModifier" : false, "isSummary" : true, "mapping" : [{ "identity" : "workflow", "map" : "Definition.contact" }] }, { "id" : "ImplementationGuide.description", "path" : "ImplementationGuide.description", "short" : "Natural language description of the implementation guide", "definition" : "A free text natural language description of the implementation guide from a consumer's perspective.", "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).", "min" : 0, "max" : "1", "base" : { "path" : "ImplementationGuide.description", "min" : 0, "max" : "1" }, "type" : [{ "code" : "markdown" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "Element" }], "isModifier" : false, "isSummary" : false, "mapping" : [{ "identity" : "workflow", "map" : "Definition.description" }] }, { "id" : "ImplementationGuide.useContext", "path" : "ImplementationGuide.useContext", "short" : "The context that the content is intended to support", "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.", "comment" : "When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.", "requirements" : "Assist in searching for appropriate content.", "min" : 0, "max" : "*", "base" : { "path" : "ImplementationGuide.useContext", "min" : 0, "max" : "*" }, "type" : [{ "code" : "UsageContext" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "Element" }], "isModifier" : false, "isSummary" : true, "mapping" : [{ "identity" : "workflow", "map" : "Definition.useContext" }] }, { "id" : "ImplementationGuide.jurisdiction", "path" : "ImplementationGuide.jurisdiction", "short" : "Intended jurisdiction for implementation guide (if applicable)", "definition" : "A legal or geographic region in which the implementation guide is intended to be used.", "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.", "min" : 0, "max" : "*", "base" : { "path" : "ImplementationGuide.jurisdiction", "min" : 0, "max" : "*" }, "type" : [{ "code" : "CodeableConcept" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "Element" }], "isModifier" : false, "isSummary" : true, "binding" : { "extension" : [{ "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString" : "Jurisdiction" }, { "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding", "valueBoolean" : true }], "strength" : "extensible", "description" : "Countries and regions within which this artifact is targeted for use.", "valueSet" : "http://hl7.org/fhir/ValueSet/jurisdiction" }, "mapping" : [{ "identity" : "workflow", "map" : "Definition.jurisdiction" }] }, { "id" : "ImplementationGuide.copyright", "path" : "ImplementationGuide.copyright", "short" : "Use and/or publishing restrictions", "definition" : "A copyright statement relating to the implementation guide and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the implementation guide.", "requirements" : "Consumers must be able to determine any legal restrictions on the use of the implementation guide and/or its content.", "alias" : ["License", "Restrictions"], "min" : 0, "max" : "1", "base" : { "path" : "ImplementationGuide.copyright", "min" : 0, "max" : "1" }, "type" : [{ "code" : "markdown" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "Element" }], "isModifier" : false, "isSummary" : false, "mapping" : [{ "identity" : "workflow", "map" : "Definition.copyright" }, { "identity" : "objimpl", "map" : "no-gen-base" }] }, { "id" : "ImplementationGuide.packageId", "path" : "ImplementationGuide.packageId", "short" : "NPM Package name for IG", "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.", "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.", "min" : 1, "max" : "1", "base" : { "path" : "ImplementationGuide.packageId", "min" : 1, "max" : "1" }, "type" : [{ "code" : "id" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "Element" }], "isModifier" : false, "isSummary" : true }, { "id" : "ImplementationGuide.license", "path" : "ImplementationGuide.license", "short" : "SPDX license code for this IG (or not-open-source)", "definition" : "The license that applies to this Implementation Guide, using an SPDX license code, or 'not-open-source'.", "min" : 0, "max" : "1", "base" : { "path" : "ImplementationGuide.license", "min" : 0, "max" : "1" }, "type" : [{ "code" : "code" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "Element" }], "isModifier" : false, "isSummary" : true, "binding" : { "extension" : [{ "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString" : "SPDXLicense" }], "strength" : "required", "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/).", "valueSet" : "http://hl7.org/fhir/ValueSet/spdx-license|4.2.0" } }, { "id" : "ImplementationGuide.fhirVersion", "path" : "ImplementationGuide.fhirVersion", "short" : "FHIR Version(s) this Implementation Guide targets", "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.2.0. for this version.", "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.", "min" : 1, "max" : "*", "base" : { "path" : "ImplementationGuide.fhirVersion", "min" : 1, "max" : "*" }, "type" : [{ "code" : "code" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "Element" }], "isModifier" : false, "isSummary" : true, "binding" : { "extension" : [{ "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString" : "FHIRVersion" }, { "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding", "valueBoolean" : true }], "strength" : "required", "description" : "All published FHIR Versions.", "valueSet" : "http://hl7.org/fhir/ValueSet/FHIR-version|4.2.0" } }, { "id" : "ImplementationGuide.dependsOn", "path" : "ImplementationGuide.dependsOn", "short" : "Another Implementation guide this depends on", "definition" : "Another implementation guide that this implementation depends on. Typically, an implementation guide uses value sets, profiles etc.defined in other implementation guides.", "min" : 0, "max" : "*", "base" : { "path" : "ImplementationGuide.dependsOn", "min" : 0, "max" : "*" }, "type" : [{ "code" : "BackboneElement" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "Element" }], "isModifier" : false, "isSummary" : true }, { "id" : "ImplementationGuide.dependsOn.id", "path" : "ImplementationGuide.dependsOn.id", "representation" : ["xmlAttr"], "short" : "Unique id for inter-element referencing", "definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min" : 0, "max" : "1", "base" : { "path" : "Element.id", "min" : 0, "max" : "1" }, "type" : [{ "extension" : [{ "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUri" : "id" }], "code" : "http://hl7.org/fhirpath/System.String" }], "isModifier" : false, "isSummary" : false, "mapping" : [{ "identity" : "rim", "map" : "n/a" }] }, { "id" : "ImplementationGuide.dependsOn.extension", "path" : "ImplementationGuide.dependsOn.extension", "short" : "Additional content defined by implementations", "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 manageable, 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.", "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.", "alias" : ["extensions", "user content"], "min" : 0, "max" : "*", "base" : { "path" : "Element.extension", "min" : 0, "max" : "*" }, "type" : [{ "code" : "Extension" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "Element" }, { "key" : "ext-1", "severity" : "error", "human" : "Must have either extensions or value[x], not both", "expression" : "extension.exists() != value.exists()", "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", "source" : "Extension" }], "isModifier" : false, "isSummary" : false, "mapping" : [{ "identity" : "rim", "map" : "n/a" }] }, { "id" : "ImplementationGuide.dependsOn.modifierExtension", "path" : "ImplementationGuide.dependsOn.modifierExtension", "short" : "Extensions that cannot be ignored even if unrecognized", "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 manageable, 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).", "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.", "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).", "alias" : ["extensions", "user content", "modifiers"], "min" : 0, "max" : "*", "base" : { "path" : "BackboneElement.modifierExtension", "min" : 0, "max" : "*" }, "type" : [{ "code" : "Extension" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "Element" }, { "key" : "ext-1", "severity" : "error", "human" : "Must have either extensions or value[x], not both", "expression" : "extension.exists() != value.exists()", "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", "source" : "Extension" }], "isModifier" : true, "isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them", "isSummary" : true, "mapping" : [{ "identity" : "rim", "map" : "N/A" }] }, { "id" : "ImplementationGuide.dependsOn.uri", "path" : "ImplementationGuide.dependsOn.uri", "short" : "Identity of the IG that this depends on", "definition" : "A canonical reference to the Implementation guide for the dependency.", "comment" : "Usually, A canonical reference to the implementation guide is the same as the master location at which the implementation guide is published.", "min" : 1, "max" : "1", "base" : { "path" : "ImplementationGuide.dependsOn.uri", "min" : 1, "max" : "1" }, "type" : [{ "code" : "canonical", "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/ImplementationGuide"] }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "Element" }], "isModifier" : false, "isSummary" : true }, { "id" : "ImplementationGuide.dependsOn.packageId", "path" : "ImplementationGuide.dependsOn.packageId", "short" : "NPM Package name for IG this depends on", "definition" : "The NPM package name for the Implementation Guide that this IG depends on.", "min" : 0, "max" : "1", "base" : { "path" : "ImplementationGuide.dependsOn.packageId", "min" : 0, "max" : "1" }, "type" : [{ "code" : "id" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "Element" }], "isModifier" : false, "isSummary" : true }, { "id" : "ImplementationGuide.dependsOn.version", "path" : "ImplementationGuide.dependsOn.version", "short" : "Version of the IG", "definition" : "The version of the IG that is depended on, when the correct version is required to understand the IG correctly.", "comment" : "This follows the syntax of the NPM packaging version field - see [[reference]].", "min" : 0, "max" : "1", "base" : { "path" : "ImplementationGuide.dependsOn.version", "min" : 0, "max" : "1" }, "type" : [{ "code" : "string" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "Element" }], "isModifier" : false, "isSummary" : true }, { "id" : "ImplementationGuide.global", "path" : "ImplementationGuide.global", "short" : "Profiles that apply globally", "definition" : "A set of profiles that all resources covered by this implementation guide must conform to.", "comment" : "See [Default Profiles](implementationguide.html#default) for a discussion of which resources are 'covered' by an implementation guide.", "min" : 0, "max" : "*", "base" : { "path" : "ImplementationGuide.global", "min" : 0, "max" : "*" }, "type" : [{ "code" : "BackboneElement" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "Element" }], "isModifier" : false, "isSummary" : true }, { "id" : "ImplementationGuide.global.id", "path" : "ImplementationGuide.global.id", "representation" : ["xmlAttr"], "short" : "Unique id for inter-element referencing", "definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min" : 0, "max" : "1", "base" : { "path" : "Element.id", "min" : 0, "max" : "1" }, "type" : [{ "extension" : [{ "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUri" : "id" }], "code" : "http://hl7.org/fhirpath/System.String" }], "isModifier" : false, "isSummary" : false, "mapping" : [{ "identity" : "rim", "map" : "n/a" }] }, { "id" : "ImplementationGuide.global.extension", "path" : "ImplementationGuide.global.extension", "short" : "Additional content defined by implementations", "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 manageable, 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.", "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.", "alias" : ["extensions", "user content"], "min" : 0, "max" : "*", "base" : { "path" : "Element.extension", "min" : 0, "max" : "*" }, "type" : [{ "code" : "Extension" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "Element" }, { "key" : "ext-1", "severity" : "error", "human" : "Must have either extensions or value[x], not both", "expression" : "extension.exists() != value.exists()", "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", "source" : "Extension" }], "isModifier" : false, "isSummary" : false, "mapping" : [{ "identity" : "rim", "map" : "n/a" }] }, { "id" : "ImplementationGuide.global.modifierExtension", "path" : "ImplementationGuide.global.modifierExtension", "short" : "Extensions that cannot be ignored even if unrecognized", "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 manageable, 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).", "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.", "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).", "alias" : ["extensions", "user content", "modifiers"], "min" : 0, "max" : "*", "base" : { "path" : "BackboneElement.modifierExtension", "min" : 0, "max" : "*" }, "type" : [{ "code" : "Extension" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "Element" }, { "key" : "ext-1", "severity" : "error", "human" : "Must have either extensions or value[x], not both", "expression" : "extension.exists() != value.exists()", "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", "source" : "Extension" }], "isModifier" : true, "isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them", "isSummary" : true, "mapping" : [{ "identity" : "rim", "map" : "N/A" }] }, { "id" : "ImplementationGuide.global.type", "path" : "ImplementationGuide.global.type", "short" : "Type this profile applies to", "definition" : "The type of resource that all instances must conform to.", "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.", "min" : 1, "max" : "1", "base" : { "path" : "ImplementationGuide.global.type", "min" : 1, "max" : "1" }, "type" : [{ "code" : "code" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "Element" }], "isModifier" : false, "isSummary" : true, "binding" : { "extension" : [{ "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString" : "ResourceType" }, { "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding", "valueBoolean" : true }], "strength" : "required", "description" : "One of the resource types defined as part of this version of FHIR.", "valueSet" : "http://hl7.org/fhir/ValueSet/resource-types|4.2.0" } }, { "id" : "ImplementationGuide.global.profile", "path" : "ImplementationGuide.global.profile", "short" : "Profile that all resources must conform to", "definition" : "A reference to the profile that all instances must conform to.", "min" : 1, "max" : "1", "base" : { "path" : "ImplementationGuide.global.profile", "min" : 1, "max" : "1" }, "type" : [{ "code" : "canonical", "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/StructureDefinition"] }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "Element" }], "isModifier" : false, "isSummary" : true }, { "id" : "ImplementationGuide.definition", "path" : "ImplementationGuide.definition", "short" : "Information needed to build the IG", "definition" : "The information needed by an IG publisher tool to publish the whole implementation guide.", "comment" : "Principally, this consists of information abuot source resource and file locations, and build parameters and templates.", "min" : 0, "max" : "1", "base" : { "path" : "ImplementationGuide.definition", "min" : 0, "max" : "1" }, "type" : [{ "code" : "BackboneElement" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "Element" }, { "key" : "ig-1", "severity" : "error", "human" : "If a resource has a groupingId, it must refer to a grouping defined in the Implementation Guide", "expression" : "resource.groupingId.all(%context.grouping.id contains $this)", "xpath" : "count(for $id in (f:resource/f:groupingId) return $id[not(ancestor::f:grouping/@id=$id/@value)])=0" }], "isModifier" : false, "isSummary" : false }, { "id" : "ImplementationGuide.definition.id", "path" : "ImplementationGuide.definition.id", "representation" : ["xmlAttr"], "short" : "Unique id for inter-element referencing", "definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min" : 0, "max" : "1", "base" : { "path" : "Element.id", "min" : 0, "max" : "1" }, "type" : [{ "extension" : [{ "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUri" : "id" }], "code" : "http://hl7.org/fhirpath/System.String" }], "isModifier" : false, "isSummary" : false, "mapping" : [{ "identity" : "rim", "map" : "n/a" }] }, { "id" : "ImplementationGuide.definition.extension", "path" : "ImplementationGuide.definition.extension", "short" : "Additional content defined by implementations", "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 manageable, 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.", "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.", "alias" : ["extensions", "user content"], "min" : 0, "max" : "*", "base" : { "path" : "Element.extension", "min" : 0, "max" : "*" }, "type" : [{ "code" : "Extension" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "Element" }, { "key" : "ext-1", "severity" : "error", "human" : "Must have either extensions or value[x], not both", "expression" : "extension.exists() != value.exists()", "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", "source" : "Extension" }], "isModifier" : false, "isSummary" : false, "mapping" : [{ "identity" : "rim", "map" : "n/a" }] }, { "id" : "ImplementationGuide.definition.modifierExtension", "path" : "ImplementationGuide.definition.modifierExtension", "short" : "Extensions that cannot be ignored even if unrecognized", "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 manageable, 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).", "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.", "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).", "alias" : ["extensions", "user content", "modifiers"], "min" : 0, "max" : "*", "base" : { "path" : "BackboneElement.modifierExtension", "min" : 0, "max" : "*" }, "type" : [{ "code" : "Extension" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "Element" }, { "key" : "ext-1", "severity" : "error", "human" : "Must have either extensions or value[x], not both", "expression" : "extension.exists() != value.exists()", "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", "source" : "Extension" }], "isModifier" : true, "isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them", "isSummary" : true, "mapping" : [{ "identity" : "rim", "map" : "N/A" }] }, { "id" : "ImplementationGuide.definition.grouping", "path" : "ImplementationGuide.definition.grouping", "short" : "Grouping used to present related resources in the IG", "definition" : "A logical group of resources. Logical groups can be used when building pages.", "comment" : "Groupings are arbitrary sub-divisions of content. Typically, they are used to help build Table of Contents automatically.", "min" : 0, "max" : "*", "base" : { "path" : "ImplementationGuide.definition.grouping", "min" : 0, "max" : "*" }, "type" : [{ "code" : "BackboneElement" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "Element" }], "isModifier" : false, "isSummary" : false }, { "id" : "ImplementationGuide.definition.grouping.id", "path" : "ImplementationGuide.definition.grouping.id", "representation" : ["xmlAttr"], "short" : "Unique id for inter-element referencing", "definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min" : 0, "max" : "1", "base" : { "path" : "Element.id", "min" : 0, "max" : "1" }, "type" : [{ "extension" : [{ "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUri" : "id" }], "code" : "http://hl7.org/fhirpath/System.String" }], "isModifier" : false, "isSummary" : false, "mapping" : [{ "identity" : "rim", "map" : "n/a" }] }, { "id" : "ImplementationGuide.definition.grouping.extension", "path" : "ImplementationGuide.definition.grouping.extension", "short" : "Additional content defined by implementations", "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 manageable, 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.", "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.", "alias" : ["extensions", "user content"], "min" : 0, "max" : "*", "base" : { "path" : "Element.extension", "min" : 0, "max" : "*" }, "type" : [{ "code" : "Extension" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "Element" }, { "key" : "ext-1", "severity" : "error", "human" : "Must have either extensions or value[x], not both", "expression" : "extension.exists() != value.exists()", "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", "source" : "Extension" }], "isModifier" : false, "isSummary" : false, "mapping" : [{ "identity" : "rim", "map" : "n/a" }] }, { "id" : "ImplementationGuide.definition.grouping.modifierExtension", "path" : "ImplementationGuide.definition.grouping.modifierExtension", "short" : "Extensions that cannot be ignored even if unrecognized", "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 manageable, 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).", "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.", "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).", "alias" : ["extensions", "user content", "modifiers"], "min" : 0, "max" : "*", "base" : { "path" : "BackboneElement.modifierExtension", "min" : 0, "max" : "*" }, "type" : [{ "code" : "Extension" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "Element" }, { "key" : "ext-1", "severity" : "error", "human" : "Must have either extensions or value[x], not both", "expression" : "extension.exists() != value.exists()", "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", "source" : "Extension" }], "isModifier" : true, "isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them", "isSummary" : true, "mapping" : [{ "identity" : "rim", "map" : "N/A" }] }, { "id" : "ImplementationGuide.definition.grouping.name", "path" : "ImplementationGuide.definition.grouping.name", "short" : "Descriptive name for the package", "definition" : "The human-readable title to display for the package of resources when rendering the implementation guide.", "min" : 1, "max" : "1", "base" : { "path" : "ImplementationGuide.definition.grouping.name", "min" : 1, "max" : "1" }, "type" : [{ "code" : "string" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "Element" }], "isModifier" : false, "isSummary" : false }, { "id" : "ImplementationGuide.definition.grouping.description", "path" : "ImplementationGuide.definition.grouping.description", "short" : "Human readable text describing the package", "definition" : "Human readable text describing the package.", "min" : 0, "max" : "1", "base" : { "path" : "ImplementationGuide.definition.grouping.description", "min" : 0, "max" : "1" }, "type" : [{ "code" : "string" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "Element" }], "isModifier" : false, "isSummary" : false }, { "id" : "ImplementationGuide.definition.resource", "path" : "ImplementationGuide.definition.resource", "short" : "Resource in the implementation guide", "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.", "min" : 1, "max" : "*", "base" : { "path" : "ImplementationGuide.definition.resource", "min" : 1, "max" : "*" }, "type" : [{ "code" : "BackboneElement" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "Element" }], "isModifier" : false, "isSummary" : false }, { "id" : "ImplementationGuide.definition.resource.id", "path" : "ImplementationGuide.definition.resource.id", "representation" : ["xmlAttr"], "short" : "Unique id for inter-element referencing", "definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min" : 0, "max" : "1", "base" : { "path" : "Element.id", "min" : 0, "max" : "1" }, "type" : [{ "extension" : [{ "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUri" : "id" }], "code" : "http://hl7.org/fhirpath/System.String" }], "isModifier" : false, "isSummary" : false, "mapping" : [{ "identity" : "rim", "map" : "n/a" }] }, { "id" : "ImplementationGuide.definition.resource.extension", "path" : "ImplementationGuide.definition.resource.extension", "short" : "Additional content defined by implementations", "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 manageable, 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.", "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.", "alias" : ["extensions", "user content"], "min" : 0, "max" : "*", "base" : { "path" : "Element.extension", "min" : 0, "max" : "*" }, "type" : [{ "code" : "Extension" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "Element" }, { "key" : "ext-1", "severity" : "error", "human" : "Must have either extensions or value[x], not both", "expression" : "extension.exists() != value.exists()", "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", "source" : "Extension" }], "isModifier" : false, "isSummary" : false, "mapping" : [{ "identity" : "rim", "map" : "n/a" }] }, { "id" : "ImplementationGuide.definition.resource.modifierExtension", "path" : "ImplementationGuide.definition.resource.modifierExtension", "short" : "Extensions that cannot be ignored even if unrecognized", "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 manageable, 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).", "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.", "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).", "alias" : ["extensions", "user content", "modifiers"], "min" : 0, "max" : "*", "base" : { "path" : "BackboneElement.modifierExtension", "min" : 0, "max" : "*" }, "type" : [{ "code" : "Extension" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "Element" }, { "key" : "ext-1", "severity" : "error", "human" : "Must have either extensions or value[x], not both", "expression" : "extension.exists() != value.exists()", "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", "source" : "Extension" }], "isModifier" : true, "isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them", "isSummary" : true, "mapping" : [{ "identity" : "rim", "map" : "N/A" }] }, { "id" : "ImplementationGuide.definition.resource.reference", "path" : "ImplementationGuide.definition.resource.reference", "short" : "Location of the resource", "definition" : "Where this resource is found.", "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.", "min" : 1, "max" : "1", "base" : { "path" : "ImplementationGuide.definition.resource.reference", "min" : 1, "max" : "1" }, "type" : [{ "code" : "Reference", "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Resource"] }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "Element" }], "isModifier" : false, "isSummary" : false }, { "id" : "ImplementationGuide.definition.resource.fhirVersion", "path" : "ImplementationGuide.definition.resource.fhirVersion", "short" : "Versions this applies to (if different to IG)", "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.", "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 [applicable-version](extension-structuredefinition-applicable-version.html) extension.", "min" : 0, "max" : "*", "base" : { "path" : "ImplementationGuide.definition.resource.fhirVersion", "min" : 0, "max" : "*" }, "type" : [{ "code" : "code" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "Element" }], "isModifier" : false, "isSummary" : false, "binding" : { "extension" : [{ "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString" : "FHIRVersion" }, { "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding", "valueBoolean" : true }], "strength" : "required", "description" : "All published FHIR Versions.", "valueSet" : "http://hl7.org/fhir/ValueSet/FHIR-version|4.2.0" } }, { "id" : "ImplementationGuide.definition.resource.name", "path" : "ImplementationGuide.definition.resource.name", "short" : "Human Name for the resource", "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).", "min" : 0, "max" : "1", "base" : { "path" : "ImplementationGuide.definition.resource.name", "min" : 0, "max" : "1" }, "type" : [{ "code" : "string" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "Element" }], "isModifier" : false, "isSummary" : false }, { "id" : "ImplementationGuide.definition.resource.description", "path" : "ImplementationGuide.definition.resource.description", "short" : "Reason why included in guide", "definition" : "A description of the reason that a resource has been included in the implementation guide.", "comment" : "This is mostly used with examples to explain why it is present (though they can have extensive comments in the examples).", "min" : 0, "max" : "1", "base" : { "path" : "ImplementationGuide.definition.resource.description", "min" : 0, "max" : "1" }, "type" : [{ "code" : "string" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "Element" }], "isModifier" : false, "isSummary" : false }, { "id" : "ImplementationGuide.definition.resource.example[x]", "path" : "ImplementationGuide.definition.resource.example[x]", "short" : "Is an example/What is this an example of?", "definition" : "If true or a reference, indicates the resource is an example instance. If a reference is present, indicates that the example is an example of the specified profile.", "comment" : "Examples: \n\n* StructureDefinition -> Any \n* ValueSet -> expansion \n* OperationDefinition -> Parameters \n* Questionnaire -> QuestionnaireResponse.", "min" : 0, "max" : "1", "base" : { "path" : "ImplementationGuide.definition.resource.example[x]", "min" : 0, "max" : "1" }, "type" : [{ "code" : "boolean" }, { "code" : "canonical", "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/StructureDefinition"] }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "Element" }], "isModifier" : false, "isSummary" : false }, { "id" : "ImplementationGuide.definition.resource.groupingId", "path" : "ImplementationGuide.definition.resource.groupingId", "short" : "Grouping this is part of", "definition" : "Reference to the id of the grouping this resource appears in.", "comment" : "This must correspond to a package.id element within this implementation guide.", "min" : 0, "max" : "1", "base" : { "path" : "ImplementationGuide.definition.resource.groupingId", "min" : 0, "max" : "1" }, "type" : [{ "code" : "id" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "Element" }], "isModifier" : false, "isSummary" : false }, { "id" : "ImplementationGuide.definition.page", "path" : "ImplementationGuide.definition.page", "short" : "Page/Section in the Guide", "definition" : "A page / section in the implementation guide. The root page is the implementation guide home page.", "comment" : "Pages automatically become sections if they have sub-pages. By convention, the home page is called index.html.", "min" : 0, "max" : "1", "base" : { "path" : "ImplementationGuide.definition.page", "min" : 0, "max" : "1" }, "type" : [{ "code" : "BackboneElement" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "Element" }], "isModifier" : false, "isSummary" : false }, { "id" : "ImplementationGuide.definition.page.id", "path" : "ImplementationGuide.definition.page.id", "representation" : ["xmlAttr"], "short" : "Unique id for inter-element referencing", "definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min" : 0, "max" : "1", "base" : { "path" : "Element.id", "min" : 0, "max" : "1" }, "type" : [{ "extension" : [{ "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUri" : "id" }], "code" : "http://hl7.org/fhirpath/System.String" }], "isModifier" : false, "isSummary" : false, "mapping" : [{ "identity" : "rim", "map" : "n/a" }] }, { "id" : "ImplementationGuide.definition.page.extension", "path" : "ImplementationGuide.definition.page.extension", "short" : "Additional content defined by implementations", "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 manageable, 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.", "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.", "alias" : ["extensions", "user content"], "min" : 0, "max" : "*", "base" : { "path" : "Element.extension", "min" : 0, "max" : "*" }, "type" : [{ "code" : "Extension" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "Element" }, { "key" : "ext-1", "severity" : "error", "human" : "Must have either extensions or value[x], not both", "expression" : "extension.exists() != value.exists()", "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", "source" : "Extension" }], "isModifier" : false, "isSummary" : false, "mapping" : [{ "identity" : "rim", "map" : "n/a" }] }, { "id" : "ImplementationGuide.definition.page.modifierExtension", "path" : "ImplementationGuide.definition.page.modifierExtension", "short" : "Extensions that cannot be ignored even if unrecognized", "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 manageable, 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).", "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.", "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).", "alias" : ["extensions", "user content", "modifiers"], "min" : 0, "max" : "*", "base" : { "path" : "BackboneElement.modifierExtension", "min" : 0, "max" : "*" }, "type" : [{ "code" : "Extension" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "Element" }, { "key" : "ext-1", "severity" : "error", "human" : "Must have either extensions or value[x], not both", "expression" : "extension.exists() != value.exists()", "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", "source" : "Extension" }], "isModifier" : true, "isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them", "isSummary" : true, "mapping" : [{ "identity" : "rim", "map" : "N/A" }] }, { "id" : "ImplementationGuide.definition.page.name[x]", "path" : "ImplementationGuide.definition.page.name[x]", "short" : "Where to find that page", "definition" : "The source address for the page.", "comment" : "The publishing tool will autogenerate source for list (source = n/a) and inject included implementations for include (source = uri of guide to include).", "min" : 1, "max" : "1", "base" : { "path" : "ImplementationGuide.definition.page.name[x]", "min" : 1, "max" : "1" }, "type" : [{ "code" : "url" }, { "code" : "Reference", "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Binary"] }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "Element" }], "isModifier" : false, "isSummary" : false }, { "id" : "ImplementationGuide.definition.page.title", "path" : "ImplementationGuide.definition.page.title", "short" : "Short title shown for navigational assistance", "definition" : "A short title used to represent this page in navigational structures such as table of contents, bread crumbs, etc.", "min" : 1, "max" : "1", "base" : { "path" : "ImplementationGuide.definition.page.title", "min" : 1, "max" : "1" }, "type" : [{ "code" : "string" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "Element" }], "isModifier" : false, "isSummary" : false }, { "id" : "ImplementationGuide.definition.page.generation", "path" : "ImplementationGuide.definition.page.generation", "short" : "html | markdown | xml | generated", "definition" : "A code that indicates how the page is generated.", "min" : 1, "max" : "1", "base" : { "path" : "ImplementationGuide.definition.page.generation", "min" : 1, "max" : "1" }, "type" : [{ "code" : "code" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "Element" }], "isModifier" : false, "isSummary" : false, "binding" : { "extension" : [{ "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString" : "GuidePageGeneration" }], "strength" : "required", "description" : "A code that indicates how the page is generated.", "valueSet" : "http://hl7.org/fhir/ValueSet/guide-page-generation|4.2.0" } }, { "id" : "ImplementationGuide.definition.page.page", "path" : "ImplementationGuide.definition.page.page", "short" : "Nested Pages / Sections", "definition" : "Nested Pages/Sections under this page.", "comment" : "The implementation guide breadcrumbs may be generated from this structure.", "min" : 0, "max" : "*", "base" : { "path" : "ImplementationGuide.definition.page.page", "min" : 0, "max" : "*" }, "contentReference" : "#ImplementationGuide.definition.page", "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "Element" }], "isModifier" : false, "isSummary" : false }, { "id" : "ImplementationGuide.definition.parameter", "path" : "ImplementationGuide.definition.parameter", "short" : "Defines how IG is built by tools", "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.", "comment" : "see [confluence](https://confluence.hl7.org/display/FHIR/Implementation+Guide+Parameters) for the parameters defined by the HL7 IG publisher.", "min" : 0, "max" : "*", "base" : { "path" : "ImplementationGuide.definition.parameter", "min" : 0, "max" : "*" }, "type" : [{ "code" : "BackboneElement" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "Element" }], "isModifier" : false, "isSummary" : false }, { "id" : "ImplementationGuide.definition.parameter.id", "path" : "ImplementationGuide.definition.parameter.id", "representation" : ["xmlAttr"], "short" : "Unique id for inter-element referencing", "definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min" : 0, "max" : "1", "base" : { "path" : "Element.id", "min" : 0, "max" : "1" }, "type" : [{ "extension" : [{ "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUri" : "id" }], "code" : "http://hl7.org/fhirpath/System.String" }], "isModifier" : false, "isSummary" : false, "mapping" : [{ "identity" : "rim", "map" : "n/a" }] }, { "id" : "ImplementationGuide.definition.parameter.extension", "path" : "ImplementationGuide.definition.parameter.extension", "short" : "Additional content defined by implementations", "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 manageable, 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.", "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.", "alias" : ["extensions", "user content"], "min" : 0, "max" : "*", "base" : { "path" : "Element.extension", "min" : 0, "max" : "*" }, "type" : [{ "code" : "Extension" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "Element" }, { "key" : "ext-1", "severity" : "error", "human" : "Must have either extensions or value[x], not both", "expression" : "extension.exists() != value.exists()", "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", "source" : "Extension" }], "isModifier" : false, "isSummary" : false, "mapping" : [{ "identity" : "rim", "map" : "n/a" }] }, { "id" : "ImplementationGuide.definition.parameter.modifierExtension", "path" : "ImplementationGuide.definition.parameter.modifierExtension", "short" : "Extensions that cannot be ignored even if unrecognized", "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 manageable, 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).", "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.", "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).", "alias" : ["extensions", "user content", "modifiers"], "min" : 0, "max" : "*", "base" : { "path" : "BackboneElement.modifierExtension", "min" : 0, "max" : "*" }, "type" : [{ "code" : "Extension" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "Element" }, { "key" : "ext-1", "severity" : "error", "human" : "Must have either extensions or value[x], not both", "expression" : "extension.exists() != value.exists()", "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", "source" : "Extension" }], "isModifier" : true, "isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them", "isSummary" : true, "mapping" : [{ "identity" : "rim", "map" : "N/A" }] }, { "id" : "ImplementationGuide.definition.parameter.code", "path" : "ImplementationGuide.definition.parameter.code", "short" : "Code that identifies parameter", "definition" : "Code that identifies parameter.", "min" : 1, "max" : "1", "base" : { "path" : "ImplementationGuide.definition.parameter.code", "min" : 1, "max" : "1" }, "type" : [{ "code" : "string" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "Element" }], "isModifier" : false, "isSummary" : false }, { "id" : "ImplementationGuide.definition.parameter.value", "path" : "ImplementationGuide.definition.parameter.value", "short" : "Value for named type", "definition" : "Value for named type.", "min" : 1, "max" : "1", "base" : { "path" : "ImplementationGuide.definition.parameter.value", "min" : 1, "max" : "1" }, "type" : [{ "code" : "string" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "Element" }], "isModifier" : false, "isSummary" : false }, { "id" : "ImplementationGuide.definition.template", "path" : "ImplementationGuide.definition.template", "short" : "A template for building resources", "definition" : "A template for building resources.", "min" : 0, "max" : "*", "base" : { "path" : "ImplementationGuide.definition.template", "min" : 0, "max" : "*" }, "type" : [{ "code" : "BackboneElement" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "Element" }], "isModifier" : false, "isSummary" : false }, { "id" : "ImplementationGuide.definition.template.id", "path" : "ImplementationGuide.definition.template.id", "representation" : ["xmlAttr"], "short" : "Unique id for inter-element referencing", "definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min" : 0, "max" : "1", "base" : { "path" : "Element.id", "min" : 0, "max" : "1" }, "type" : [{ "extension" : [{ "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUri" : "id" }], "code" : "http://hl7.org/fhirpath/System.String" }], "isModifier" : false, "isSummary" : false, "mapping" : [{ "identity" : "rim", "map" : "n/a" }] }, { "id" : "ImplementationGuide.definition.template.extension", "path" : "ImplementationGuide.definition.template.extension", "short" : "Additional content defined by implementations", "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 manageable, 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.", "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.", "alias" : ["extensions", "user content"], "min" : 0, "max" : "*", "base" : { "path" : "Element.extension", "min" : 0, "max" : "*" }, "type" : [{ "code" : "Extension" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "Element" }, { "key" : "ext-1", "severity" : "error", "human" : "Must have either extensions or value[x], not both", "expression" : "extension.exists() != value.exists()", "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", "source" : "Extension" }], "isModifier" : false, "isSummary" : false, "mapping" : [{ "identity" : "rim", "map" : "n/a" }] }, { "id" : "ImplementationGuide.definition.template.modifierExtension", "path" : "ImplementationGuide.definition.template.modifierExtension", "short" : "Extensions that cannot be ignored even if unrecognized", "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 manageable, 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).", "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.", "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).", "alias" : ["extensions", "user content", "modifiers"], "min" : 0, "max" : "*", "base" : { "path" : "BackboneElement.modifierExtension", "min" : 0, "max" : "*" }, "type" : [{ "code" : "Extension" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "Element" }, { "key" : "ext-1", "severity" : "error", "human" : "Must have either extensions or value[x], not both", "expression" : "extension.exists() != value.exists()", "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", "source" : "Extension" }], "isModifier" : true, "isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them", "isSummary" : true, "mapping" : [{ "identity" : "rim", "map" : "N/A" }] }, { "id" : "ImplementationGuide.definition.template.code", "path" : "ImplementationGuide.definition.template.code", "short" : "Type of template specified", "definition" : "Type of template specified.", "min" : 1, "max" : "1", "base" : { "path" : "ImplementationGuide.definition.template.code", "min" : 1, "max" : "1" }, "type" : [{ "code" : "code" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "Element" }], "isModifier" : false, "isSummary" : false }, { "id" : "ImplementationGuide.definition.template.source", "path" : "ImplementationGuide.definition.template.source", "short" : "The source location for the template", "definition" : "The source location for the template.", "min" : 1, "max" : "1", "base" : { "path" : "ImplementationGuide.definition.template.source", "min" : 1, "max" : "1" }, "type" : [{ "code" : "string" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "Element" }], "isModifier" : false, "isSummary" : false }, { "id" : "ImplementationGuide.definition.template.scope", "path" : "ImplementationGuide.definition.template.scope", "short" : "The scope in which the template applies", "definition" : "The scope in which the template applies.", "min" : 0, "max" : "1", "base" : { "path" : "ImplementationGuide.definition.template.scope", "min" : 0, "max" : "1" }, "type" : [{ "code" : "string" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "Element" }], "isModifier" : false, "isSummary" : false }, { "id" : "ImplementationGuide.manifest", "path" : "ImplementationGuide.manifest", "short" : "Information about an assembled IG", "definition" : "Information about an assembled implementation guide, created by the publication tooling.", "min" : 0, "max" : "1", "base" : { "path" : "ImplementationGuide.manifest", "min" : 0, "max" : "1" }, "type" : [{ "code" : "BackboneElement" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "Element" }], "isModifier" : false, "isSummary" : false }, { "id" : "ImplementationGuide.manifest.id", "path" : "ImplementationGuide.manifest.id", "representation" : ["xmlAttr"], "short" : "Unique id for inter-element referencing", "definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min" : 0, "max" : "1", "base" : { "path" : "Element.id", "min" : 0, "max" : "1" }, "type" : [{ "extension" : [{ "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUri" : "id" }], "code" : "http://hl7.org/fhirpath/System.String" }], "isModifier" : false, "isSummary" : false, "mapping" : [{ "identity" : "rim", "map" : "n/a" }] }, { "id" : "ImplementationGuide.manifest.extension", "path" : "ImplementationGuide.manifest.extension", "short" : "Additional content defined by implementations", "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 manageable, 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.", "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.", "alias" : ["extensions", "user content"], "min" : 0, "max" : "*", "base" : { "path" : "Element.extension", "min" : 0, "max" : "*" }, "type" : [{ "code" : "Extension" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "Element" }, { "key" : "ext-1", "severity" : "error", "human" : "Must have either extensions or value[x], not both", "expression" : "extension.exists() != value.exists()", "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", "source" : "Extension" }], "isModifier" : false, "isSummary" : false, "mapping" : [{ "identity" : "rim", "map" : "n/a" }] }, { "id" : "ImplementationGuide.manifest.modifierExtension", "path" : "ImplementationGuide.manifest.modifierExtension", "short" : "Extensions that cannot be ignored even if unrecognized", "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 manageable, 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).", "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.", "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).", "alias" : ["extensions", "user content", "modifiers"], "min" : 0, "max" : "*", "base" : { "path" : "BackboneElement.modifierExtension", "min" : 0, "max" : "*" }, "type" : [{ "code" : "Extension" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "Element" }, { "key" : "ext-1", "severity" : "error", "human" : "Must have either extensions or value[x], not both", "expression" : "extension.exists() != value.exists()", "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", "source" : "Extension" }], "isModifier" : true, "isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them", "isSummary" : true, "mapping" : [{ "identity" : "rim", "map" : "N/A" }] }, { "id" : "ImplementationGuide.manifest.rendering", "path" : "ImplementationGuide.manifest.rendering", "short" : "Location of rendered implementation guide", "definition" : "A pointer to official web page, PDF or other rendering of the implementation guide.", "min" : 0, "max" : "1", "base" : { "path" : "ImplementationGuide.manifest.rendering", "min" : 0, "max" : "1" }, "type" : [{ "code" : "url" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "Element" }], "isModifier" : false, "isSummary" : true }, { "id" : "ImplementationGuide.manifest.resource", "extension" : [{ "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name", "valueString" : "ManifestResource" }], "path" : "ImplementationGuide.manifest.resource", "short" : "Resource in the implementation guide", "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.", "min" : 1, "max" : "*", "base" : { "path" : "ImplementationGuide.manifest.resource", "min" : 1, "max" : "*" }, "type" : [{ "code" : "BackboneElement" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "Element" }], "isModifier" : false, "isSummary" : true }, { "id" : "ImplementationGuide.manifest.resource.id", "path" : "ImplementationGuide.manifest.resource.id", "representation" : ["xmlAttr"], "short" : "Unique id for inter-element referencing", "definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min" : 0, "max" : "1", "base" : { "path" : "Element.id", "min" : 0, "max" : "1" }, "type" : [{ "extension" : [{ "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUri" : "id" }], "code" : "http://hl7.org/fhirpath/System.String" }], "isModifier" : false, "isSummary" : false, "mapping" : [{ "identity" : "rim", "map" : "n/a" }] }, { "id" : "ImplementationGuide.manifest.resource.extension", "path" : "ImplementationGuide.manifest.resource.extension", "short" : "Additional content defined by implementations", "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 manageable, 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.", "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.", "alias" : ["extensions", "user content"], "min" : 0, "max" : "*", "base" : { "path" : "Element.extension", "min" : 0, "max" : "*" }, "type" : [{ "code" : "Extension" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "Element" }, { "key" : "ext-1", "severity" : "error", "human" : "Must have either extensions or value[x], not both", "expression" : "extension.exists() != value.exists()", "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", "source" : "Extension" }], "isModifier" : false, "isSummary" : false, "mapping" : [{ "identity" : "rim", "map" : "n/a" }] }, { "id" : "ImplementationGuide.manifest.resource.modifierExtension", "path" : "ImplementationGuide.manifest.resource.modifierExtension", "short" : "Extensions that cannot be ignored even if unrecognized", "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 manageable, 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).", "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.", "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).", "alias" : ["extensions", "user content", "modifiers"], "min" : 0, "max" : "*", "base" : { "path" : "BackboneElement.modifierExtension", "min" : 0, "max" : "*" }, "type" : [{ "code" : "Extension" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "Element" }, { "key" : "ext-1", "severity" : "error", "human" : "Must have either extensions or value[x], not both", "expression" : "extension.exists() != value.exists()", "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", "source" : "Extension" }], "isModifier" : true, "isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them", "isSummary" : true, "mapping" : [{ "identity" : "rim", "map" : "N/A" }] }, { "id" : "ImplementationGuide.manifest.resource.reference", "path" : "ImplementationGuide.manifest.resource.reference", "short" : "Location of the resource", "definition" : "Where this resource is found.", "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.", "min" : 1, "max" : "1", "base" : { "path" : "ImplementationGuide.manifest.resource.reference", "min" : 1, "max" : "1" }, "type" : [{ "code" : "Reference", "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Resource"] }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "Element" }], "isModifier" : false, "isSummary" : true }, { "id" : "ImplementationGuide.manifest.resource.example[x]", "path" : "ImplementationGuide.manifest.resource.example[x]", "short" : "Is an example/What is this an example of?", "definition" : "If true or a reference, indicates the resource is an example instance. If a reference is present, indicates that the example is an example of the specified profile.", "comment" : "Typically, conformance resources and knowledge resources are directly part of the implementation guide, with their normal meaning, and patient linked resources are usually examples. However this is not always true.", "min" : 0, "max" : "1", "base" : { "path" : "ImplementationGuide.manifest.resource.example[x]", "min" : 0, "max" : "1" }, "type" : [{ "code" : "boolean" }, { "code" : "canonical", "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/StructureDefinition"] }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "Element" }], "isModifier" : false, "isSummary" : false }, { "id" : "ImplementationGuide.manifest.resource.relativePath", "path" : "ImplementationGuide.manifest.resource.relativePath", "short" : "Relative path for page in IG", "definition" : "The relative path for primary page for this resource within the IG.", "comment" : "Appending 'rendering' + \"/\" + this should resolve to the resource page.", "min" : 0, "max" : "1", "base" : { "path" : "ImplementationGuide.manifest.resource.relativePath", "min" : 0, "max" : "1" }, "type" : [{ "code" : "url" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "Element" }], "isModifier" : false, "isSummary" : false }, { "id" : "ImplementationGuide.manifest.page", "extension" : [{ "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name", "valueString" : "ManifestPage" }], "path" : "ImplementationGuide.manifest.page", "short" : "HTML page within the parent IG", "definition" : "Information about a page within the IG.", "requirements" : "Allows validation of hyperlinks from a derived IG to this IG without a local copy of the IG.", "min" : 0, "max" : "*", "base" : { "path" : "ImplementationGuide.manifest.page", "min" : 0, "max" : "*" }, "type" : [{ "code" : "BackboneElement" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "Element" }], "isModifier" : false, "isSummary" : false }, { "id" : "ImplementationGuide.manifest.page.id", "path" : "ImplementationGuide.manifest.page.id", "representation" : ["xmlAttr"], "short" : "Unique id for inter-element referencing", "definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min" : 0, "max" : "1", "base" : { "path" : "Element.id", "min" : 0, "max" : "1" }, "type" : [{ "extension" : [{ "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUri" : "id" }], "code" : "http://hl7.org/fhirpath/System.String" }], "isModifier" : false, "isSummary" : false, "mapping" : [{ "identity" : "rim", "map" : "n/a" }] }, { "id" : "ImplementationGuide.manifest.page.extension", "path" : "ImplementationGuide.manifest.page.extension", "short" : "Additional content defined by implementations", "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 manageable, 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.", "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.", "alias" : ["extensions", "user content"], "min" : 0, "max" : "*", "base" : { "path" : "Element.extension", "min" : 0, "max" : "*" }, "type" : [{ "code" : "Extension" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "Element" }, { "key" : "ext-1", "severity" : "error", "human" : "Must have either extensions or value[x], not both", "expression" : "extension.exists() != value.exists()", "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", "source" : "Extension" }], "isModifier" : false, "isSummary" : false, "mapping" : [{ "identity" : "rim", "map" : "n/a" }] }, { "id" : "ImplementationGuide.manifest.page.modifierExtension", "path" : "ImplementationGuide.manifest.page.modifierExtension", "short" : "Extensions that cannot be ignored even if unrecognized", "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 manageable, 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).", "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.", "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).", "alias" : ["extensions", "user content", "modifiers"], "min" : 0, "max" : "*", "base" : { "path" : "BackboneElement.modifierExtension", "min" : 0, "max" : "*" }, "type" : [{ "code" : "Extension" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "Element" }, { "key" : "ext-1", "severity" : "error", "human" : "Must have either extensions or value[x], not both", "expression" : "extension.exists() != value.exists()", "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", "source" : "Extension" }], "isModifier" : true, "isModifierReason" : "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them", "isSummary" : true, "mapping" : [{ "identity" : "rim", "map" : "N/A" }] }, { "id" : "ImplementationGuide.manifest.page.name", "path" : "ImplementationGuide.manifest.page.name", "short" : "HTML page name", "definition" : "Relative path to the page.", "comment" : "Appending 'rendering' + \"/\" + this should resolve to the page.", "min" : 1, "max" : "1", "base" : { "path" : "ImplementationGuide.manifest.page.name", "min" : 1, "max" : "1" }, "type" : [{ "code" : "string" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "Element" }], "isModifier" : false, "isSummary" : false }, { "id" : "ImplementationGuide.manifest.page.title", "path" : "ImplementationGuide.manifest.page.title", "short" : "Title of the page, for references", "definition" : "Label for the page intended for human display.", "requirements" : "Allows generation of labels for markdown-generated hyperlinks.", "min" : 0, "max" : "1", "base" : { "path" : "ImplementationGuide.manifest.page.title", "min" : 0, "max" : "1" }, "type" : [{ "code" : "string" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "Element" }], "isModifier" : false, "isSummary" : false }, { "id" : "ImplementationGuide.manifest.page.anchor", "path" : "ImplementationGuide.manifest.page.anchor", "short" : "Anchor available on the page", "definition" : "The name of an anchor available on the page.", "comment" : "Appending 'rendering' + \"/\" + page.name + \"#\" + page.anchor should resolve to the anchor.", "requirements" : "Allows validation of hyperlinks from a derived IG to this IG without a local copy of the IG.", "min" : 0, "max" : "*", "base" : { "path" : "ImplementationGuide.manifest.page.anchor", "min" : 0, "max" : "*" }, "type" : [{ "code" : "string" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "Element" }], "isModifier" : false, "isSummary" : false }, { "id" : "ImplementationGuide.manifest.image", "path" : "ImplementationGuide.manifest.image", "short" : "Image within the IG", "definition" : "Indicates a relative path to an image that exists within the IG.", "requirements" : "Allows validation of image links from a derived IG to this IG without a local copy of the IG.", "min" : 0, "max" : "*", "base" : { "path" : "ImplementationGuide.manifest.image", "min" : 0, "max" : "*" }, "type" : [{ "code" : "string" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "Element" }], "isModifier" : false, "isSummary" : false }, { "id" : "ImplementationGuide.manifest.other", "path" : "ImplementationGuide.manifest.other", "short" : "Additional linkable file in IG", "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.", "requirements" : "Allows validation of links from a derived IG to this IG without a local copy of the IG.", "min" : 0, "max" : "*", "base" : { "path" : "ImplementationGuide.manifest.other", "min" : 0, "max" : "*" }, "type" : [{ "code" : "string" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "Element" }], "isModifier" : false, "isSummary" : false }] }, "differential" : { "element" : [{ "id" : "ImplementationGuide", "path" : "ImplementationGuide", "short" : "A set of rules about how FHIR is used", "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.", "min" : 0, "max" : "*", "constraint" : [{ "key" : "cnl-0", "severity" : "warning", "human" : "Name should be usable as an identifier for the module by machine processing applications such as code generation", "expression" : "name.matches('[A-Z]([A-Za-z0-9_]){0,254}')", "xpath" : "not(exists(f:name/@value)) or matches(f:name/@value, '[A-Z]([A-Za-z0-9_]){0,254}')" }, { "key" : "ig-2", "severity" : "error", "human" : "If a resource has a fhirVersion, it must be oe of the versions defined for the Implementation Guide", "expression" : "definition.resource.fhirVersion.all(%context.fhirVersion contains $this)", "xpath" : "count(for $id in (f:resource/f:fhirVersion) return $id[not(ancestor::f:fhirVersion/@value=$id/@value)])=0" }], "mapping" : [{ "identity" : "rim", "map" : "n/a" }] }, { "id" : "ImplementationGuide.url", "path" : "ImplementationGuide.url", "short" : "Canonical identifier for this implementation guide, represented as a URI (globally unique)", "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 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.", "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.", "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.", "alias" : ["url", "authoritative-url", "destination", "identity"], "min" : 1, "max" : "1", "type" : [{ "code" : "uri" }], "isSummary" : true, "mapping" : [{ "identity" : "workflow", "map" : "Definition.url" }, { "identity" : "w5", "map" : "FiveWs.identifier" }] }, { "id" : "ImplementationGuide.version", "path" : "ImplementationGuide.version", "short" : "Business version of the implementation guide", "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.", "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].", "min" : 0, "max" : "1", "type" : [{ "code" : "string" }], "isSummary" : true, "mapping" : [{ "identity" : "workflow", "map" : "Definition.version" }, { "identity" : "w5", "map" : "FiveWs.version" }] }, { "id" : "ImplementationGuide.name", "path" : "ImplementationGuide.name", "short" : "Name for this implementation guide (computer friendly)", "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.", "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.", "requirements" : "Support human navigation and code generation.", "min" : 1, "max" : "1", "type" : [{ "code" : "string" }], "condition" : ["cnl-0"], "isSummary" : true }, { "id" : "ImplementationGuide.title", "path" : "ImplementationGuide.title", "short" : "Name for this implementation guide (human friendly)", "definition" : "A short, descriptive, user-friendly title for the implementation guide.", "comment" : "This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.", "min" : 0, "max" : "1", "type" : [{ "code" : "string" }], "isSummary" : true, "mapping" : [{ "identity" : "workflow", "map" : "Definition.title" }] }, { "id" : "ImplementationGuide.status", "path" : "ImplementationGuide.status", "short" : "draft | active | retired | unknown", "definition" : "The status of this implementation guide. Enables tracking the life-cycle of the content.", "comment" : "Allows filtering of implementation guides that are appropriate for use versus not.", "min" : 1, "max" : "1", "type" : [{ "code" : "code" }], "isModifier" : true, "isModifierReason" : "This is labeled as \"Is Modifier\" because applications should not use a retired {{title}} without due consideration", "isSummary" : true, "binding" : { "extension" : [{ "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString" : "PublicationStatus" }, { "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding", "valueBoolean" : true }], "strength" : "required", "description" : "The lifecycle status of an artifact.", "valueSet" : "http://hl7.org/fhir/ValueSet/publication-status|4.2.0" }, "mapping" : [{ "identity" : "workflow", "map" : "Definition.status" }, { "identity" : "w5", "map" : "FiveWs.status" }] }, { "id" : "ImplementationGuide.experimental", "path" : "ImplementationGuide.experimental", "short" : "For testing purposes, not real usage", "definition" : "A Boolean value to indicate that this implementation guide is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.", "comment" : "Allows filtering of implementation guides that are appropriate for use versus not.", "requirements" : "Enables experimental content to be developed following the same lifecycle that would be used for a production-level implementation guide.", "min" : 0, "max" : "1", "type" : [{ "code" : "boolean" }], "isSummary" : true, "mapping" : [{ "identity" : "workflow", "map" : "Definition.experimental" }, { "identity" : "w5", "map" : "FiveWs.class" }] }, { "id" : "ImplementationGuide.date", "path" : "ImplementationGuide.date", "short" : "Date last changed", "definition" : "The date (and optionally time) when the implementation guide was published. 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.", "comment" : "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.", "alias" : ["Revision Date"], "min" : 0, "max" : "1", "type" : [{ "code" : "dateTime" }], "isSummary" : true, "mapping" : [{ "identity" : "workflow", "map" : "Definition.date" }, { "identity" : "w5", "map" : "FiveWs.recorded" }] }, { "id" : "ImplementationGuide.publisher", "path" : "ImplementationGuide.publisher", "short" : "Name of the publisher (organization or individual)", "definition" : "The name of the organization or individual that published the implementation guide.", "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.", "requirements" : "Helps establish the \"authority/credibility\" of the implementation guide. May also allow for contact.", "min" : 0, "max" : "1", "type" : [{ "code" : "string" }], "isSummary" : true, "mapping" : [{ "identity" : "workflow", "map" : "Definition.publisher" }, { "identity" : "w5", "map" : "FiveWs.witness" }] }, { "id" : "ImplementationGuide.contact", "path" : "ImplementationGuide.contact", "short" : "Contact details for the publisher", "definition" : "Contact details to assist a user in finding and communicating with the publisher.", "comment" : "May be a web site, an email address, a telephone number, etc.", "min" : 0, "max" : "*", "type" : [{ "code" : "ContactDetail" }], "isSummary" : true, "mapping" : [{ "identity" : "workflow", "map" : "Definition.contact" }] }, { "id" : "ImplementationGuide.description", "path" : "ImplementationGuide.description", "short" : "Natural language description of the implementation guide", "definition" : "A free text natural language description of the implementation guide from a consumer's perspective.", "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).", "min" : 0, "max" : "1", "type" : [{ "code" : "markdown" }], "mapping" : [{ "identity" : "workflow", "map" : "Definition.description" }] }, { "id" : "ImplementationGuide.useContext", "path" : "ImplementationGuide.useContext", "short" : "The context that the content is intended to support", "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.", "comment" : "When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.", "requirements" : "Assist in searching for appropriate content.", "min" : 0, "max" : "*", "type" : [{ "code" : "UsageContext" }], "isSummary" : true, "mapping" : [{ "identity" : "workflow", "map" : "Definition.useContext" }] }, { "id" : "ImplementationGuide.jurisdiction", "path" : "ImplementationGuide.jurisdiction", "short" : "Intended jurisdiction for implementation guide (if applicable)", "definition" : "A legal or geographic region in which the implementation guide is intended to be used.", "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.", "min" : 0, "max" : "*", "type" : [{ "code" : "CodeableConcept" }], "isSummary" : true, "binding" : { "extension" : [{ "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString" : "Jurisdiction" }, { "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding", "valueBoolean" : true }], "strength" : "extensible", "description" : "Countries and regions within which this artifact is targeted for use.", "valueSet" : "http://hl7.org/fhir/ValueSet/jurisdiction" }, "mapping" : [{ "identity" : "workflow", "map" : "Definition.jurisdiction" }] }, { "id" : "ImplementationGuide.copyright", "path" : "ImplementationGuide.copyright", "short" : "Use and/or publishing restrictions", "definition" : "A copyright statement relating to the implementation guide and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the implementation guide.", "requirements" : "Consumers must be able to determine any legal restrictions on the use of the implementation guide and/or its content.", "alias" : ["License", "Restrictions"], "min" : 0, "max" : "1", "type" : [{ "code" : "markdown" }], "mapping" : [{ "identity" : "workflow", "map" : "Definition.copyright" }, { "identity" : "objimpl", "map" : "no-gen-base" }] }, { "id" : "ImplementationGuide.packageId", "path" : "ImplementationGuide.packageId", "short" : "NPM Package name for IG", "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.", "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.", "min" : 1, "max" : "1", "type" : [{ "code" : "id" }], "isSummary" : true }, { "id" : "ImplementationGuide.license", "path" : "ImplementationGuide.license", "short" : "SPDX license code for this IG (or not-open-source)", "definition" : "The license that applies to this Implementation Guide, using an SPDX license code, or 'not-open-source'.", "min" : 0, "max" : "1", "type" : [{ "code" : "code" }], "isSummary" : true, "binding" : { "extension" : [{ "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString" : "SPDXLicense" }], "strength" : "required", "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/).", "valueSet" : "http://hl7.org/fhir/ValueSet/spdx-license|4.2.0" } }, { "id" : "ImplementationGuide.fhirVersion", "path" : "ImplementationGuide.fhirVersion", "short" : "FHIR Version(s) this Implementation Guide targets", "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.2.0. for this version.", "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.", "min" : 1, "max" : "*", "type" : [{ "code" : "code" }], "isSummary" : true, "binding" : { "extension" : [{ "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString" : "FHIRVersion" }, { "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding", "valueBoolean" : true }], "strength" : "required", "description" : "All published FHIR Versions.", "valueSet" : "http://hl7.org/fhir/ValueSet/FHIR-version|4.2.0" } }, { "id" : "ImplementationGuide.dependsOn", "path" : "ImplementationGuide.dependsOn", "short" : "Another Implementation guide this depends on", "definition" : "Another implementation guide that this implementation depends on. Typically, an implementation guide uses value sets, profiles etc.defined in other implementation guides.", "min" : 0, "max" : "*", "type" : [{ "code" : "BackboneElement" }], "isSummary" : true }, { "id" : "ImplementationGuide.dependsOn.uri", "path" : "ImplementationGuide.dependsOn.uri", "short" : "Identity of the IG that this depends on", "definition" : "A canonical reference to the Implementation guide for the dependency.", "comment" : "Usually, A canonical reference to the implementation guide is the same as the master location at which the implementation guide is published.", "min" : 1, "max" : "1", "type" : [{ "code" : "canonical", "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/ImplementationGuide"] }], "isSummary" : true }, { "id" : "ImplementationGuide.dependsOn.packageId", "path" : "ImplementationGuide.dependsOn.packageId", "short" : "NPM Package name for IG this depends on", "definition" : "The NPM package name for the Implementation Guide that this IG depends on.", "min" : 0, "max" : "1", "type" : [{ "code" : "id" }], "isSummary" : true }, { "id" : "ImplementationGuide.dependsOn.version", "path" : "ImplementationGuide.dependsOn.version", "short" : "Version of the IG", "definition" : "The version of the IG that is depended on, when the correct version is required to understand the IG correctly.", "comment" : "This follows the syntax of the NPM packaging version field - see [[reference]].", "min" : 0, "max" : "1", "type" : [{ "code" : "string" }], "isSummary" : true }, { "id" : "ImplementationGuide.global", "path" : "ImplementationGuide.global", "short" : "Profiles that apply globally", "definition" : "A set of profiles that all resources covered by this implementation guide must conform to.", "comment" : "See [Default Profiles](implementationguide.html#default) for a discussion of which resources are 'covered' by an implementation guide.", "min" : 0, "max" : "*", "type" : [{ "code" : "BackboneElement" }], "isSummary" : true }, { "id" : "ImplementationGuide.global.type", "path" : "ImplementationGuide.global.type", "short" : "Type this profile applies to", "definition" : "The type of resource that all instances must conform to.", "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.", "min" : 1, "max" : "1", "type" : [{ "code" : "code" }], "isSummary" : true, "binding" : { "extension" : [{ "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString" : "ResourceType" }, { "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding", "valueBoolean" : true }], "strength" : "required", "description" : "One of the resource types defined as part of this version of FHIR.", "valueSet" : "http://hl7.org/fhir/ValueSet/resource-types|4.2.0" } }, { "id" : "ImplementationGuide.global.profile", "path" : "ImplementationGuide.global.profile", "short" : "Profile that all resources must conform to", "definition" : "A reference to the profile that all instances must conform to.", "min" : 1, "max" : "1", "type" : [{ "code" : "canonical", "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/StructureDefinition"] }], "isSummary" : true }, { "id" : "ImplementationGuide.definition", "path" : "ImplementationGuide.definition", "short" : "Information needed to build the IG", "definition" : "The information needed by an IG publisher tool to publish the whole implementation guide.", "comment" : "Principally, this consists of information abuot source resource and file locations, and build parameters and templates.", "min" : 0, "max" : "1", "type" : [{ "code" : "BackboneElement" }], "constraint" : [{ "key" : "ig-1", "severity" : "error", "human" : "If a resource has a groupingId, it must refer to a grouping defined in the Implementation Guide", "expression" : "resource.groupingId.all(%context.grouping.id contains $this)", "xpath" : "count(for $id in (f:resource/f:groupingId) return $id[not(ancestor::f:grouping/@id=$id/@value)])=0" }] }, { "id" : "ImplementationGuide.definition.grouping", "path" : "ImplementationGuide.definition.grouping", "short" : "Grouping used to present related resources in the IG", "definition" : "A logical group of resources. Logical groups can be used when building pages.", "comment" : "Groupings are arbitrary sub-divisions of content. Typically, they are used to help build Table of Contents automatically.", "min" : 0, "max" : "*", "type" : [{ "code" : "BackboneElement" }] }, { "id" : "ImplementationGuide.definition.grouping.name", "path" : "ImplementationGuide.definition.grouping.name", "short" : "Descriptive name for the package", "definition" : "The human-readable title to display for the package of resources when rendering the implementation guide.", "min" : 1, "max" : "1", "type" : [{ "code" : "string" }] }, { "id" : "ImplementationGuide.definition.grouping.description", "path" : "ImplementationGuide.definition.grouping.description", "short" : "Human readable text describing the package", "definition" : "Human readable text describing the package.", "min" : 0, "max" : "1", "type" : [{ "code" : "string" }] }, { "id" : "ImplementationGuide.definition.resource", "path" : "ImplementationGuide.definition.resource", "short" : "Resource in the implementation guide", "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.", "min" : 1, "max" : "*", "type" : [{ "code" : "BackboneElement" }] }, { "id" : "ImplementationGuide.definition.resource.reference", "path" : "ImplementationGuide.definition.resource.reference", "short" : "Location of the resource", "definition" : "Where this resource is found.", "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.", "min" : 1, "max" : "1", "type" : [{ "code" : "Reference", "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Resource"] }] }, { "id" : "ImplementationGuide.definition.resource.fhirVersion", "path" : "ImplementationGuide.definition.resource.fhirVersion", "short" : "Versions this applies to (if different to IG)", "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.", "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 [applicable-version](extension-structuredefinition-applicable-version.html) extension.", "min" : 0, "max" : "*", "type" : [{ "code" : "code" }], "binding" : { "extension" : [{ "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString" : "FHIRVersion" }, { "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding", "valueBoolean" : true }], "strength" : "required", "description" : "All published FHIR Versions.", "valueSet" : "http://hl7.org/fhir/ValueSet/FHIR-version|4.2.0" } }, { "id" : "ImplementationGuide.definition.resource.name", "path" : "ImplementationGuide.definition.resource.name", "short" : "Human Name for the resource", "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).", "min" : 0, "max" : "1", "type" : [{ "code" : "string" }] }, { "id" : "ImplementationGuide.definition.resource.description", "path" : "ImplementationGuide.definition.resource.description", "short" : "Reason why included in guide", "definition" : "A description of the reason that a resource has been included in the implementation guide.", "comment" : "This is mostly used with examples to explain why it is present (though they can have extensive comments in the examples).", "min" : 0, "max" : "1", "type" : [{ "code" : "string" }] }, { "id" : "ImplementationGuide.definition.resource.example[x]", "path" : "ImplementationGuide.definition.resource.example[x]", "short" : "Is an example/What is this an example of?", "definition" : "If true or a reference, indicates the resource is an example instance. If a reference is present, indicates that the example is an example of the specified profile.", "comment" : "Examples: \n\n* StructureDefinition -> Any \n* ValueSet -> expansion \n* OperationDefinition -> Parameters \n* Questionnaire -> QuestionnaireResponse.", "min" : 0, "max" : "1", "type" : [{ "code" : "boolean" }, { "code" : "canonical", "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/StructureDefinition"] }] }, { "id" : "ImplementationGuide.definition.resource.groupingId", "path" : "ImplementationGuide.definition.resource.groupingId", "short" : "Grouping this is part of", "definition" : "Reference to the id of the grouping this resource appears in.", "comment" : "This must correspond to a package.id element within this implementation guide.", "min" : 0, "max" : "1", "type" : [{ "code" : "id" }] }, { "id" : "ImplementationGuide.definition.page", "path" : "ImplementationGuide.definition.page", "short" : "Page/Section in the Guide", "definition" : "A page / section in the implementation guide. The root page is the implementation guide home page.", "comment" : "Pages automatically become sections if they have sub-pages. By convention, the home page is called index.html.", "min" : 0, "max" : "1", "type" : [{ "code" : "BackboneElement" }] }, { "id" : "ImplementationGuide.definition.page.name[x]", "path" : "ImplementationGuide.definition.page.name[x]", "short" : "Where to find that page", "definition" : "The source address for the page.", "comment" : "The publishing tool will autogenerate source for list (source = n/a) and inject included implementations for include (source = uri of guide to include).", "min" : 1, "max" : "1", "type" : [{ "code" : "url" }, { "code" : "Reference", "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Binary"] }] }, { "id" : "ImplementationGuide.definition.page.title", "path" : "ImplementationGuide.definition.page.title", "short" : "Short title shown for navigational assistance", "definition" : "A short title used to represent this page in navigational structures such as table of contents, bread crumbs, etc.", "min" : 1, "max" : "1", "type" : [{ "code" : "string" }] }, { "id" : "ImplementationGuide.definition.page.generation", "path" : "ImplementationGuide.definition.page.generation", "short" : "html | markdown | xml | generated", "definition" : "A code that indicates how the page is generated.", "min" : 1, "max" : "1", "type" : [{ "code" : "code" }], "binding" : { "extension" : [{ "url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString" : "GuidePageGeneration" }], "strength" : "required", "description" : "A code that indicates how the page is generated.", "valueSet" : "http://hl7.org/fhir/ValueSet/guide-page-generation|4.2.0" } }, { "id" : "ImplementationGuide.definition.page.page", "path" : "ImplementationGuide.definition.page.page", "short" : "Nested Pages / Sections", "definition" : "Nested Pages/Sections under this page.", "comment" : "The implementation guide breadcrumbs may be generated from this structure.", "min" : 0, "max" : "*", "contentReference" : "#ImplementationGuide.definition.page" }, { "id" : "ImplementationGuide.definition.parameter", "path" : "ImplementationGuide.definition.parameter", "short" : "Defines how IG is built by tools", "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.", "comment" : "see [confluence](https://confluence.hl7.org/display/FHIR/Implementation+Guide+Parameters) for the parameters defined by the HL7 IG publisher.", "min" : 0, "max" : "*", "type" : [{ "code" : "BackboneElement" }] }, { "id" : "ImplementationGuide.definition.parameter.code", "path" : "ImplementationGuide.definition.parameter.code", "short" : "Code that identifies parameter", "definition" : "Code that identifies parameter.", "min" : 1, "max" : "1", "type" : [{ "code" : "string" }] }, { "id" : "ImplementationGuide.definition.parameter.value", "path" : "ImplementationGuide.definition.parameter.value", "short" : "Value for named type", "definition" : "Value for named type.", "min" : 1, "max" : "1", "type" : [{ "code" : "string" }] }, { "id" : "ImplementationGuide.definition.template", "path" : "ImplementationGuide.definition.template", "short" : "A template for building resources", "definition" : "A template for building resources.", "min" : 0, "max" : "*", "type" : [{ "code" : "BackboneElement" }] }, { "id" : "ImplementationGuide.definition.template.code", "path" : "ImplementationGuide.definition.template.code", "short" : "Type of template specified", "definition" : "Type of template specified.", "min" : 1, "max" : "1", "type" : [{ "code" : "code" }] }, { "id" : "ImplementationGuide.definition.template.source", "path" : "ImplementationGuide.definition.template.source", "short" : "The source location for the template", "definition" : "The source location for the template.", "min" : 1, "max" : "1", "type" : [{ "code" : "string" }] }, { "id" : "ImplementationGuide.definition.template.scope", "path" : "ImplementationGuide.definition.template.scope", "short" : "The scope in which the template applies", "definition" : "The scope in which the template applies.", "min" : 0, "max" : "1", "type" : [{ "code" : "string" }] }, { "id" : "ImplementationGuide.manifest", "path" : "ImplementationGuide.manifest", "short" : "Information about an assembled IG", "definition" : "Information about an assembled implementation guide, created by the publication tooling.", "min" : 0, "max" : "1", "type" : [{ "code" : "BackboneElement" }] }, { "id" : "ImplementationGuide.manifest.rendering", "path" : "ImplementationGuide.manifest.rendering", "short" : "Location of rendered implementation guide", "definition" : "A pointer to official web page, PDF or other rendering of the implementation guide.", "min" : 0, "max" : "1", "type" : [{ "code" : "url" }], "isSummary" : true }, { "id" : "ImplementationGuide.manifest.resource", "extension" : [{ "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name", "valueString" : "ManifestResource" }], "path" : "ImplementationGuide.manifest.resource", "short" : "Resource in the implementation guide", "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.", "min" : 1, "max" : "*", "type" : [{ "code" : "BackboneElement" }], "isSummary" : true }, { "id" : "ImplementationGuide.manifest.resource.reference", "path" : "ImplementationGuide.manifest.resource.reference", "short" : "Location of the resource", "definition" : "Where this resource is found.", "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.", "min" : 1, "max" : "1", "type" : [{ "code" : "Reference", "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Resource"] }], "isSummary" : true }, { "id" : "ImplementationGuide.manifest.resource.example[x]", "path" : "ImplementationGuide.manifest.resource.example[x]", "short" : "Is an example/What is this an example of?", "definition" : "If true or a reference, indicates the resource is an example instance. If a reference is present, indicates that the example is an example of the specified profile.", "comment" : "Typically, conformance resources and knowledge resources are directly part of the implementation guide, with their normal meaning, and patient linked resources are usually examples. However this is not always true.", "min" : 0, "max" : "1", "type" : [{ "code" : "boolean" }, { "code" : "canonical", "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/StructureDefinition"] }] }, { "id" : "ImplementationGuide.manifest.resource.relativePath", "path" : "ImplementationGuide.manifest.resource.relativePath", "short" : "Relative path for page in IG", "definition" : "The relative path for primary page for this resource within the IG.", "comment" : "Appending 'rendering' + \"/\" + this should resolve to the resource page.", "min" : 0, "max" : "1", "type" : [{ "code" : "url" }] }, { "id" : "ImplementationGuide.manifest.page", "extension" : [{ "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name", "valueString" : "ManifestPage" }], "path" : "ImplementationGuide.manifest.page", "short" : "HTML page within the parent IG", "definition" : "Information about a page within the IG.", "requirements" : "Allows validation of hyperlinks from a derived IG to this IG without a local copy of the IG.", "min" : 0, "max" : "*", "type" : [{ "code" : "BackboneElement" }] }, { "id" : "ImplementationGuide.manifest.page.name", "path" : "ImplementationGuide.manifest.page.name", "short" : "HTML page name", "definition" : "Relative path to the page.", "comment" : "Appending 'rendering' + \"/\" + this should resolve to the page.", "min" : 1, "max" : "1", "type" : [{ "code" : "string" }] }, { "id" : "ImplementationGuide.manifest.page.title", "path" : "ImplementationGuide.manifest.page.title", "short" : "Title of the page, for references", "definition" : "Label for the page intended for human display.", "requirements" : "Allows generation of labels for markdown-generated hyperlinks.", "min" : 0, "max" : "1", "type" : [{ "code" : "string" }] }, { "id" : "ImplementationGuide.manifest.page.anchor", "path" : "ImplementationGuide.manifest.page.anchor", "short" : "Anchor available on the page", "definition" : "The name of an anchor available on the page.", "comment" : "Appending 'rendering' + \"/\" + page.name + \"#\" + page.anchor should resolve to the anchor.", "requirements" : "Allows validation of hyperlinks from a derived IG to this IG without a local copy of the IG.", "min" : 0, "max" : "*", "type" : [{ "code" : "string" }] }, { "id" : "ImplementationGuide.manifest.image", "path" : "ImplementationGuide.manifest.image", "short" : "Image within the IG", "definition" : "Indicates a relative path to an image that exists within the IG.", "requirements" : "Allows validation of image links from a derived IG to this IG without a local copy of the IG.", "min" : 0, "max" : "*", "type" : [{ "code" : "string" }] }, { "id" : "ImplementationGuide.manifest.other", "path" : "ImplementationGuide.manifest.other", "short" : "Additional linkable file in IG", "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.", "requirements" : "Allows validation of links from a derived IG to this IG without a local copy of the IG.", "min" : 0, "max" : "*", "type" : [{ "code" : "string" }] }] } }
Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.