{
"description": "A definition of a feature that applications may implement, or be required to implement. Features are an aspect of a an applications implementation that \\ngenerally impacts on the handling of data received from or provided to from the application, which makes it worth declaring. Once declared, ",
"_filename": "StructureDefinition-FeatureDefinition.json",
"package_name": "hl7.fhir.uv.application-feature",
"date": "2025-12-22T11:42:29-05:00",
"derivation": "specialization",
"publisher": "HL7 International / FHIR Infrastructure",
"fhirVersion": "5.0.0",
"jurisdiction": [ {
"coding": [ {
"code": "001",
"system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
"display": "World"
} ]
} ],
"name": "FeatureDefinition",
"mapping": [ {
"uri": "http://hl7.org/fhir/fivews",
"name": "FiveWs Pattern Mapping",
"identity": "w5"
}, {
"uri": "http://hl7.org/fhir/object-implementation",
"name": "Object Implementation Information",
"identity": "objimpl"
}, {
"uri": "http://hl7.org/v3",
"name": "RIM Mapping",
"identity": "rim"
} ],
"abstract": false,
"type": "http://hl7.org/fhir/uv/application-feature/StructureDefinition/FeatureDefinition",
"experimental": null,
"resourceType": "StructureDefinition",
"title": "Feature Definition",
"package_version": "1.0.0",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-implements",
"valueCanonical": "http://hl7.org/fhir/StructureDefinition/CanonicalResource"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode": "fhir"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-interface",
"valueBoolean": true
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger": 2,
"_valueInteger": {
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
"valueCanonical": "http://hl7.org/fhir/uv/application-feature/ImplementationGuide/hl7.fhir.uv.application-feature"
} ]
}
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "trial-use",
"_valueCode": {
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
"valueCanonical": "http://hl7.org/fhir/uv/application-feature/ImplementationGuide/hl7.fhir.uv.application-feature"
} ]
}
} ],
"snapshot": {
"element": [ {
"constraint": [ {
"key": "dom-2",
"human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"severity": "error",
"expression": "contained.contained.empty()"
}, {
"key": "dom-3",
"human": "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"severity": "error",
"expression": "contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()"
}, {
"key": "dom-4",
"human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"severity": "error",
"expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()"
}, {
"key": "dom-5",
"human": "If a resource is contained in another resource, it SHALL NOT have a security label",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"severity": "error",
"expression": "contained.meta.security.empty()"
}, {
"key": "dom-6",
"human": "A resource should have narrative for robust management",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"severity": "warning",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice",
"valueBoolean": true
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation",
"valueMarkdown": "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."
} ],
"expression": "text.`div`.exists()"
} ],
"path": "FeatureDefinition",
"min": 0,
"definition": "A definition of a feature that applications may implement, or be required to implement. Features are an aspect of a an applications implementation that \ngenerally impacts on the handling of data received from or provided to from the application, which makes it worth declaring. Once declared, ",
"isModifier": false,
"short": "Feature Definition",
"mapping": [ {
"map": "Entity. Role, or Act,Entity, Role, or Act",
"identity": "rim"
} ],
"mustSupport": false,
"max": "*",
"id": "FeatureDefinition",
"base": {
"max": "*",
"min": 0,
"path": "DomainResource"
},
"isSummary": false
}, {
"path": "FeatureDefinition.id",
"min": 0,
"definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"isModifier": false,
"short": "Logical id of this artifact",
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "id"
} ]
} ],
"mustSupport": false,
"max": "1",
"id": "FeatureDefinition.id",
"comment": "Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.",
"base": {
"max": "1",
"min": 0,
"path": "Resource.id"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "FeatureDefinition.meta",
"min": 0,
"definition": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"isModifier": false,
"short": "Metadata about the resource",
"type": [ {
"code": "Meta"
} ],
"mustSupport": false,
"max": "1",
"id": "FeatureDefinition.meta",
"base": {
"max": "1",
"min": 0,
"path": "Resource.meta"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "FeatureDefinition.implicitRules",
"min": 0,
"definition": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"isModifier": true,
"short": "A set of rules under which this content was created",
"type": [ {
"code": "uri"
} ],
"mustSupport": false,
"max": "1",
"id": "FeatureDefinition.implicitRules",
"comment": "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.",
"base": {
"max": "1",
"min": 0,
"path": "Resource.implicitRules"
},
"isModifierReason": "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation",
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "FeatureDefinition.language",
"min": 0,
"definition": "The base language in which the resource is written.",
"isModifier": false,
"short": "Language of the resource content",
"type": [ {
"code": "code"
} ],
"mustSupport": false,
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/all-languages|5.0.0",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Language"
} ],
"additional": [ {
"purpose": "starter",
"valueSet": "http://hl7.org/fhir/ValueSet/languages|5.0.0"
} ],
"description": "IETF language tag for a human language"
},
"max": "1",
"id": "FeatureDefinition.language",
"comment": "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"base": {
"max": "1",
"min": 0,
"path": "Resource.language"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "FeatureDefinition.text",
"min": 0,
"definition": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"isModifier": false,
"short": "Text summary of the resource, for human interpretation",
"mapping": [ {
"map": "Act.text?",
"identity": "rim"
} ],
"type": [ {
"code": "Narrative"
} ],
"mustSupport": false,
"alias": [ "narrative", "html", "xhtml", "display" ],
"max": "1",
"id": "FeatureDefinition.text",
"condition": [ "dom-6" ],
"comment": "Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded information is added later.",
"base": {
"max": "1",
"min": 0,
"path": "DomainResource.text"
},
"isSummary": false
}, {
"path": "FeatureDefinition.contained",
"min": 0,
"definition": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.",
"isModifier": false,
"short": "Contained, inline Resources",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Resource"
} ],
"mustSupport": false,
"alias": [ "inline resources", "anonymous resources", "contained resources" ],
"max": "*",
"id": "FeatureDefinition.contained",
"condition": [ "dom-2", "dom-4", "dom-3", "dom-5" ],
"comment": "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.",
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.contained"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "FeatureDefinition.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"isModifier": false,
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"mustSupport": false,
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "FeatureDefinition.extension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.extension"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "FeatureDefinition.modifierExtension",
"requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R5/extensibility.html#modifierExtension).",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"isModifier": true,
"short": "Extensions that cannot be ignored",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"mustSupport": false,
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "FeatureDefinition.modifierExtension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.modifierExtension"
},
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them",
"isSummary": true
}, {
"path": "FeatureDefinition.url",
"requirements": "Allows the {{title}} to be referenced by a single globally unique identifier.",
"min": 0,
"definition": "An absolute URI that is used to identify this {{title}} when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this {{title}} is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the {{title}} is stored on different servers.",
"isModifier": false,
"short": "Canonical identifier for this {{title}}, represented as an absolute URI (globally unique)",
"mapping": [ {
"map": "FiveWs.identifier",
"identity": "w5"
} ],
"type": [ {
"code": "uri"
} ],
"mustSupport": false,
"max": "1",
"id": "FeatureDefinition.url",
"comment": "Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.\n\nThe determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in [Technical and Business Versions](http://hl7.org/fhir/R5/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](http://hl7.org/fhir/R5/resource.html#meta) element to indicate where the current master source of the resource can be found.",
"base": {
"max": "1",
"min": 0,
"path": "CanonicalResource.url"
},
"isSummary": true
}, {
"path": "FeatureDefinition.identifier",
"requirements": "Allows externally provided and/or usable business identifiers to be easily associated with the {{title}}.",
"min": 0,
"definition": "A formal identifier that is used to identify this {{title}} when it is represented in other formats, or referenced in a specification, model, design or an instance.",
"isModifier": false,
"short": "Additional identifier for the {{title}}",
"mapping": [ {
"map": "FiveWs.identifier",
"identity": "w5"
}, {
"map": "no-gen-base",
"identity": "objimpl"
} ],
"type": [ {
"code": "Identifier"
} ],
"mustSupport": false,
"max": "*",
"id": "FeatureDefinition.identifier",
"comment": "Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this {{title}} outside of FHIR, where it is not possible to use the logical URI.",
"base": {
"max": "*",
"min": 0,
"path": "CanonicalResource.identifier"
},
"isSummary": true
}, {
"path": "FeatureDefinition.version",
"min": 0,
"definition": "The identifier that is used to identify this version of the {{title}} when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the {{title}} 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 without additional knowledge. (See the versionAlgorithm element.)",
"isModifier": false,
"short": "Business version of the {{title}}",
"mapping": [ {
"map": "FiveWs.version",
"identity": "w5"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"max": "1",
"id": "FeatureDefinition.version",
"comment": "There may be different {{title}}s that have the same url 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 {{title}} with the format [url]|[version]. The version SHOULD NOT contain a '#' - see [Business Version](http://hl7.org/fhir/R5/resource.html#bv-format).",
"base": {
"max": "1",
"min": 0,
"path": "CanonicalResource.version"
},
"isSummary": true
}, {
"path": "FeatureDefinition.versionAlgorithm[x]",
"min": 0,
"definition": "Indicates the mechanism used to compare versions to determine which is more current.",
"isModifier": false,
"short": "How to compare versions",
"type": [ {
"code": "string"
}, {
"code": "Coding"
} ],
"mustSupport": false,
"binding": {
"strength": "extensible",
"valueSet": "http://hl7.org/fhir/ValueSet/version-algorithm|5.0.0"
},
"max": "1",
"id": "FeatureDefinition.versionAlgorithm[x]",
"comment": "If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 and a 0 if the version ordering can't be successfully be determined.",
"base": {
"max": "1",
"min": 0,
"path": "CanonicalResource.versionAlgorithm[x]"
},
"isSummary": true
}, {
"path": "FeatureDefinition.name",
"requirements": "Supports code generation.",
"min": 0,
"definition": "A natural language name identifying the {{title}}. This name should be usable as an identifier for the resource by machine processing applications such as code generation.",
"isModifier": false,
"short": "Name for this {{title}} (computer friendly)",
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"max": "1",
"id": "FeatureDefinition.name",
"condition": [ "cnl-0" ],
"comment": "The name is not expected to be globally unique. The name should be a simple alphanumeric type no-whitespace name to ensure that it is machine-processing friendly.",
"base": {
"max": "1",
"min": 0,
"path": "CanonicalResource.name"
},
"isSummary": true
}, {
"path": "FeatureDefinition.title",
"min": 0,
"definition": "A short, descriptive, user-friendly title for the {{title}}.",
"isModifier": false,
"short": "Name for this {{title}} (human friendly)",
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"max": "1",
"id": "FeatureDefinition.title",
"comment": "This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.",
"base": {
"max": "1",
"min": 0,
"path": "CanonicalResource.title"
},
"isSummary": true
}, {
"path": "FeatureDefinition.status",
"requirements": "Enables tracking the life-cycle of the content and filtering of {{title}}s that are appropriate for use versus not.",
"min": 1,
"definition": "The current state of this {{title}}.",
"isModifier": true,
"short": "draft | active | retired | unknown",
"mapping": [ {
"map": "FiveWs.status",
"identity": "w5"
} ],
"type": [ {
"code": "code"
} ],
"mustSupport": false,
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/publication-status|5.0.0",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "PublicationStatus"
} ],
"description": "The lifecycle status of an artifact."
},
"max": "1",
"id": "FeatureDefinition.status",
"comment": "A nominal state-transition diagram can be found in the [Definition pattern](http://hl7.org/fhir/R5/definition.html#statemachine) documentation.\n\nUnknown does not represent 'other' - one of the defined statuses must apply. Unknown is used when the authoring system is not sure what the current status is.\n\nSee guidance around (not) making local changes to elements [here](http://hl7.org/fhir/R5/canonicalresource.html#localization).",
"base": {
"max": "1",
"min": 1,
"path": "CanonicalResource.status"
},
"isModifierReason": "This is labeled as \"Is Modifier\" because applications should not use a retired {{title}} without due consideration",
"isSummary": true
}, {
"path": "FeatureDefinition.experimental",
"requirements": "Enables experimental content to be developed following the same lifecycle that would be used for a production-level {{title}}.",
"min": 0,
"definition": "A Boolean value to indicate that this {{title}} is authored for testing purposes (or education/evaluation/marketing) and is not intended for genuine usage.",
"isModifier": false,
"short": "For testing purposes, not real usage",
"mapping": [ {
"map": "FiveWs.class",
"identity": "w5"
} ],
"type": [ {
"code": "boolean"
} ],
"mustSupport": false,
"meaningWhenMissing": "If absent, this resource is treated as though it is not experimental.",
"max": "1",
"id": "FeatureDefinition.experimental",
"comment": "Allows filtering of {{title}}s that are appropriate for use versus not.",
"base": {
"max": "1",
"min": 0,
"path": "CanonicalResource.experimental"
},
"isSummary": true
}, {
"path": "FeatureDefinition.date",
"min": 0,
"definition": "The date (and optionally time) when the {{title}} was last significantly changed. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the {{title}} changes.",
"isModifier": false,
"short": "Date last changed",
"mapping": [ {
"map": "FiveWs.recorded",
"identity": "w5"
} ],
"type": [ {
"code": "dateTime"
} ],
"mustSupport": false,
"alias": [ "Revision Date" ],
"max": "1",
"id": "FeatureDefinition.date",
"comment": "The date is often not tracked until the resource is published, but may be present on draft content. Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the {{title}}. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.\n\nSee guidance around (not) making local changes to elements [here](http://hl7.org/fhir/R5/canonicalresource.html#localization).",
"base": {
"max": "1",
"min": 0,
"path": "CanonicalResource.date"
},
"isSummary": true
}, {
"path": "FeatureDefinition.publisher",
"requirements": "Helps establish the \"authority/credibility\" of the {{title}}. May also allow for contact.",
"min": 0,
"definition": "The name of the organization or individual responsible for the release and ongoing maintenance of the {{title}}.",
"isModifier": false,
"short": "Name of the publisher/steward (organization or individual)",
"mapping": [ {
"map": "FiveWs.witness",
"identity": "w5"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"max": "1",
"id": "FeatureDefinition.publisher",
"comment": "Usually an organization but may be an individual. The publisher (or steward) of the {{title}} is the organization or individual primarily responsible for the maintenance and upkeep of the {{title}}. 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 {{title}}. This item SHOULD be populated unless the information is available from context.",
"base": {
"max": "1",
"min": 0,
"path": "CanonicalResource.publisher"
},
"isSummary": true
}, {
"path": "FeatureDefinition.contact",
"min": 0,
"definition": "Contact details to assist a user in finding and communicating with the publisher.",
"isModifier": false,
"short": "Contact details for the publisher",
"type": [ {
"code": "ContactDetail"
} ],
"mustSupport": false,
"max": "*",
"id": "FeatureDefinition.contact",
"comment": "May be a web site, an email address, a telephone number, etc.\n\nSee guidance around (not) making local changes to elements [here](http://hl7.org/fhir/R5/canonicalresource.html#localization).",
"base": {
"max": "*",
"min": 0,
"path": "CanonicalResource.contact"
},
"isSummary": true
}, {
"path": "FeatureDefinition.description",
"min": 0,
"definition": "A free text natural language description of the {{title}} from a consumer's perspective.",
"isModifier": false,
"short": "Natural language description of the {{title}}",
"type": [ {
"code": "markdown"
} ],
"mustSupport": false,
"max": "1",
"id": "FeatureDefinition.description",
"comment": "This description can be used to capture details such as comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the {{title}} as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context.",
"base": {
"max": "1",
"min": 0,
"path": "CanonicalResource.description"
},
"isSummary": false
}, {
"path": "FeatureDefinition.useContext",
"requirements": "Assist in searching for appropriate content.",
"min": 0,
"definition": "The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate {{title}}s.",
"isModifier": false,
"short": "The context that the content is intended to support",
"type": [ {
"code": "UsageContext"
} ],
"mustSupport": false,
"max": "*",
"id": "FeatureDefinition.useContext",
"comment": "When multiple useContexts are specified, there is no expectation that all or even any of the contexts apply.",
"base": {
"max": "*",
"min": 0,
"path": "CanonicalResource.useContext"
},
"isSummary": true
}, {
"path": "FeatureDefinition.jurisdiction",
"min": 0,
"definition": "A legal or geographic region in which the {{title}} is intended to be used.",
"isModifier": false,
"short": "Intended jurisdiction for {{title}} (if applicable)",
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": false,
"binding": {
"strength": "extensible",
"valueSet": "http://hl7.org/fhir/ValueSet/jurisdiction|5.0.0",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Jurisdiction"
} ],
"description": "Countries and regions within which this artifact is targeted for use."
},
"max": "*",
"id": "FeatureDefinition.jurisdiction",
"comment": "It may be possible for the {{title}} to be used in jurisdictions other than those for which it was originally designed or intended.\n\nDEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'jurisdiction' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#jurisdiction and useContext.valueCodeableConcept indicating the jurisdiction.)",
"base": {
"max": "*",
"min": 0,
"path": "CanonicalResource.jurisdiction"
},
"isSummary": true
}, {
"path": "FeatureDefinition.purpose",
"min": 0,
"definition": "Explanation of why this {{title}} is needed and why it has been designed as it has.",
"isModifier": false,
"short": "Why this {{title}} is defined",
"mapping": [ {
"map": "FiveWs.why[x]",
"identity": "w5"
}, {
"map": "no-gen-base",
"identity": "objimpl"
} ],
"type": [ {
"code": "markdown"
} ],
"mustSupport": false,
"max": "1",
"id": "FeatureDefinition.purpose",
"comment": "This element does not describe the usage of the {{title}}. Instead, it provides traceability of \"why\" the resource is either needed or \"why\" it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this {{title}}.",
"base": {
"max": "1",
"min": 0,
"path": "CanonicalResource.purpose"
},
"isSummary": false
}, {
"path": "FeatureDefinition.copyright",
"requirements": "Consumers must be able to determine any legal restrictions on the use of the {{title}} and/or its content.",
"min": 0,
"definition": "A copyright statement relating to the {{title}} and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the {{title}}.",
"isModifier": false,
"short": "Use and/or publishing restrictions",
"mapping": [ {
"map": "no-gen-base",
"identity": "objimpl"
} ],
"type": [ {
"code": "markdown"
} ],
"mustSupport": false,
"alias": [ "License", "Restrictions" ],
"max": "1",
"id": "FeatureDefinition.copyright",
"comment": "The short copyright declaration (e.g. (c) '2015+ xyz organization' should be sent in the copyrightLabel element.",
"base": {
"max": "1",
"min": 0,
"path": "CanonicalResource.copyright"
},
"isSummary": false
}, {
"path": "FeatureDefinition.copyrightLabel",
"requirements": "Defines the content expected to be rendered in all representations of the artifact.",
"min": 0,
"definition": "A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved').",
"isModifier": false,
"short": "Copyright holder and year(s)",
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "FeatureDefinition.copyrightLabel",
"comment": "The (c) symbol should NOT be included in this string. It will be added by software when rendering the notation. Full details about licensing, restrictions, warrantees, etc. goes in the more general 'copyright' element.",
"base": {
"max": "1",
"min": 0,
"path": "CanonicalResource.copyrightLabel"
},
"isSummary": false
}, {
"path": "FeatureDefinition.valueType",
"min": 1,
"definition": "Features are very boolean: true or false for whether the application implements the feature, but the value \nassociated with the feature might be a number, a string, or some kind of code",
"short": "Type of value associated with the feature",
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/data-types"
},
"max": "1",
"id": "FeatureDefinition.valueType",
"base": {
"max": "1",
"min": 1,
"path": "FeatureDefinition.valueType"
}
}, {
"id": "FeatureDefinition.valueSet",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "FeatureDefinition.valueSet"
},
"path": "FeatureDefinition.valueSet",
"type": [ {
"code": "canonical",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/ValueSet" ]
} ],
"short": "ValueSet that controls what coded value are allowed",
"definition": "If a value set is specified, the value of the data type must come from the value set, and the \nvalue type must be one of the bindeable types defined in the FHIR specification"
}, {
"id": "FeatureDefinition.contextDefinition",
"max": "1",
"min": 1,
"base": {
"max": "1",
"min": 1,
"path": "FeatureDefinition.contextDefinition"
},
"path": "FeatureDefinition.contextDefinition",
"type": [ {
"code": "markdown"
} ],
"short": "Human readable documentation describing how to interpret the context fields",
"definition": "The contextDefinition provides human readable documentation describing how to interpret the context fields."
}, {
"path": "FeatureDefinition.contextExpressionLanguage",
"min": 0,
"definition": "The contextExpressionLanguage specifies the mime type of context, if context uses an expression language.",
"short": "The mime type of context, if context uses an expression language",
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/mimetypes"
},
"max": "1",
"id": "FeatureDefinition.contextExpressionLanguage",
"base": {
"max": "1",
"min": 0,
"path": "FeatureDefinition.contextExpressionLanguage"
}
}, {
"id": "FeatureDefinition.context",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "FeatureDefinition.context"
},
"path": "FeatureDefinition.context",
"type": [ {
"code": "string"
} ],
"short": "The context(s) on which this feature can be defined",
"definition": "The context(s) on which this feature can be defined. This is used to state where the feature applies. some\nfeatures are defined on applications, but others apply to particular resources, or operations on resources, or particular\ncode systems etc"
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "FeatureDefinition.qualifier",
"min": 0,
"definition": "A qualifier is an extra piece of information that MAY or SHALL be provided when the feature is described/specified \nthat provides additional information about the feature. E.g. a feature defined on a resource may only be applicable \nto particular events associated with the resource, or ...?",
"short": "A qualifier that might provided more information about a feature implementation",
"type": [ {
"code": "BackboneElement"
} ],
"max": "*",
"id": "FeatureDefinition.qualifier",
"base": {
"max": "*",
"min": 0,
"path": "FeatureDefinition.qualifier"
}
}, {
"path": "FeatureDefinition.qualifier.id",
"min": 0,
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"isModifier": false,
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "id"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "FeatureDefinition.qualifier.id",
"condition": [ "ele-1" ],
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "FeatureDefinition.qualifier.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"isModifier": false,
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "FeatureDefinition.qualifier.extension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "FeatureDefinition.qualifier.modifierExtension",
"requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R5/extensibility.html#modifierExtension).",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"isModifier": true,
"short": "Extensions that cannot be ignored even if unrecognized",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "FeatureDefinition.qualifier.modifierExtension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "BackboneElement.modifierExtension"
},
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true
}, {
"id": "FeatureDefinition.qualifier.name",
"max": "1",
"min": 1,
"base": {
"max": "1",
"min": 1,
"path": "FeatureDefinition.qualifier.name"
},
"path": "FeatureDefinition.qualifier.name",
"type": [ {
"code": "code"
} ],
"short": "The name of the feature",
"definition": "The name of the feature"
}, {
"id": "FeatureDefinition.qualifier.description",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "FeatureDefinition.qualifier.description"
},
"path": "FeatureDefinition.qualifier.description",
"type": [ {
"code": "string"
} ],
"short": "A human-readable description of the qualifier.",
"definition": "A human-readable description of the qualifier."
}, {
"path": "FeatureDefinition.qualifier.valueType",
"min": 1,
"definition": "Features are very boolean: true or false for whether the application implements the feature, but the value \nassociated with the feature might be a number, a string, or some kind of code",
"short": "Type of value associated with the feature",
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/data-types"
},
"max": "1",
"id": "FeatureDefinition.qualifier.valueType",
"base": {
"max": "1",
"min": 1,
"path": "FeatureDefinition.qualifier.valueType"
}
}, {
"id": "FeatureDefinition.qualifier.optional",
"max": "1",
"min": 1,
"base": {
"max": "1",
"min": 1,
"path": "FeatureDefinition.qualifier.optional"
},
"path": "FeatureDefinition.qualifier.optional",
"type": [ {
"code": "boolean"
} ],
"short": "Whether the feature is optional, or must always be present",
"definition": "Whether the feature is optional, or must always be present when a feature is referred to"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version",
"valueString": "5.0.0"
} ]
},
"status": "active",
"id": "2485559c-d658-4bc3-afe0-501a6ef5867c",
"kind": "logical",
"url": "http://hl7.org/fhir/uv/application-feature/StructureDefinition/FeatureDefinition",
"version": "1.0.0",
"differential": {
"element": [ {
"id": "FeatureDefinition",
"path": "FeatureDefinition",
"short": "Feature Definition",
"definition": "A definition of a feature that applications may implement, or be required to implement. Features are an aspect of a an applications implementation that \ngenerally impacts on the handling of data received from or provided to from the application, which makes it worth declaring. Once declared, "
}, {
"path": "FeatureDefinition.url",
"requirements": "Allows the {{title}} to be referenced by a single globally unique identifier.",
"min": 0,
"definition": "An absolute URI that is used to identify this {{title}} when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this {{title}} is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the {{title}} is stored on different servers.",
"isModifier": false,
"short": "Canonical identifier for this {{title}}, represented as an absolute URI (globally unique)",
"mapping": [ {
"map": "FiveWs.identifier",
"identity": "w5"
} ],
"type": [ {
"code": "uri"
} ],
"mustSupport": false,
"max": "1",
"id": "FeatureDefinition.url",
"comment": "Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.\n\nThe determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in [Technical and Business Versions](http://hl7.org/fhir/R5/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](http://hl7.org/fhir/R5/resource.html#meta) element to indicate where the current master source of the resource can be found.",
"base": {
"max": "1",
"min": 0,
"path": "CanonicalResource.url"
},
"isSummary": true
}, {
"path": "FeatureDefinition.identifier",
"requirements": "Allows externally provided and/or usable business identifiers to be easily associated with the {{title}}.",
"min": 0,
"definition": "A formal identifier that is used to identify this {{title}} when it is represented in other formats, or referenced in a specification, model, design or an instance.",
"isModifier": false,
"short": "Additional identifier for the {{title}}",
"mapping": [ {
"map": "FiveWs.identifier",
"identity": "w5"
}, {
"map": "no-gen-base",
"identity": "objimpl"
} ],
"type": [ {
"code": "Identifier"
} ],
"mustSupport": false,
"max": "*",
"id": "FeatureDefinition.identifier",
"comment": "Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this {{title}} outside of FHIR, where it is not possible to use the logical URI.",
"base": {
"max": "*",
"min": 0,
"path": "CanonicalResource.identifier"
},
"isSummary": true
}, {
"path": "FeatureDefinition.version",
"min": 0,
"definition": "The identifier that is used to identify this version of the {{title}} when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the {{title}} 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 without additional knowledge. (See the versionAlgorithm element.)",
"isModifier": false,
"short": "Business version of the {{title}}",
"mapping": [ {
"map": "FiveWs.version",
"identity": "w5"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"max": "1",
"id": "FeatureDefinition.version",
"comment": "There may be different {{title}}s that have the same url 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 {{title}} with the format [url]|[version]. The version SHOULD NOT contain a '#' - see [Business Version](http://hl7.org/fhir/R5/resource.html#bv-format).",
"base": {
"max": "1",
"min": 0,
"path": "CanonicalResource.version"
},
"isSummary": true
}, {
"path": "FeatureDefinition.versionAlgorithm[x]",
"min": 0,
"definition": "Indicates the mechanism used to compare versions to determine which is more current.",
"isModifier": false,
"short": "How to compare versions",
"type": [ {
"code": "string"
}, {
"code": "Coding"
} ],
"mustSupport": false,
"binding": {
"strength": "extensible",
"valueSet": "http://hl7.org/fhir/ValueSet/version-algorithm|5.0.0"
},
"max": "1",
"id": "FeatureDefinition.versionAlgorithm[x]",
"comment": "If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 and a 0 if the version ordering can't be successfully be determined.",
"base": {
"max": "1",
"min": 0,
"path": "CanonicalResource.versionAlgorithm[x]"
},
"isSummary": true
}, {
"path": "FeatureDefinition.name",
"requirements": "Supports code generation.",
"min": 0,
"definition": "A natural language name identifying the {{title}}. This name should be usable as an identifier for the resource by machine processing applications such as code generation.",
"isModifier": false,
"short": "Name for this {{title}} (computer friendly)",
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"max": "1",
"id": "FeatureDefinition.name",
"condition": [ "cnl-0" ],
"comment": "The name is not expected to be globally unique. The name should be a simple alphanumeric type no-whitespace name to ensure that it is machine-processing friendly.",
"base": {
"max": "1",
"min": 0,
"path": "CanonicalResource.name"
},
"isSummary": true
}, {
"path": "FeatureDefinition.title",
"min": 0,
"definition": "A short, descriptive, user-friendly title for the {{title}}.",
"isModifier": false,
"short": "Name for this {{title}} (human friendly)",
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"max": "1",
"id": "FeatureDefinition.title",
"comment": "This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.",
"base": {
"max": "1",
"min": 0,
"path": "CanonicalResource.title"
},
"isSummary": true
}, {
"path": "FeatureDefinition.status",
"requirements": "Enables tracking the life-cycle of the content and filtering of {{title}}s that are appropriate for use versus not.",
"min": 1,
"definition": "The current state of this {{title}}.",
"isModifier": true,
"short": "draft | active | retired | unknown",
"mapping": [ {
"map": "FiveWs.status",
"identity": "w5"
} ],
"type": [ {
"code": "code"
} ],
"mustSupport": false,
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/publication-status|5.0.0",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "PublicationStatus"
} ],
"description": "The lifecycle status of an artifact."
},
"max": "1",
"id": "FeatureDefinition.status",
"comment": "A nominal state-transition diagram can be found in the [Definition pattern](http://hl7.org/fhir/R5/definition.html#statemachine) documentation.\n\nUnknown does not represent 'other' - one of the defined statuses must apply. Unknown is used when the authoring system is not sure what the current status is.\n\nSee guidance around (not) making local changes to elements [here](http://hl7.org/fhir/R5/canonicalresource.html#localization).",
"base": {
"max": "1",
"min": 1,
"path": "CanonicalResource.status"
},
"isModifierReason": "This is labeled as \"Is Modifier\" because applications should not use a retired {{title}} without due consideration",
"isSummary": true
}, {
"path": "FeatureDefinition.experimental",
"requirements": "Enables experimental content to be developed following the same lifecycle that would be used for a production-level {{title}}.",
"min": 0,
"definition": "A Boolean value to indicate that this {{title}} is authored for testing purposes (or education/evaluation/marketing) and is not intended for genuine usage.",
"isModifier": false,
"short": "For testing purposes, not real usage",
"mapping": [ {
"map": "FiveWs.class",
"identity": "w5"
} ],
"type": [ {
"code": "boolean"
} ],
"mustSupport": false,
"meaningWhenMissing": "If absent, this resource is treated as though it is not experimental.",
"max": "1",
"id": "FeatureDefinition.experimental",
"comment": "Allows filtering of {{title}}s that are appropriate for use versus not.",
"base": {
"max": "1",
"min": 0,
"path": "CanonicalResource.experimental"
},
"isSummary": true
}, {
"path": "FeatureDefinition.date",
"min": 0,
"definition": "The date (and optionally time) when the {{title}} was last significantly changed. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the {{title}} changes.",
"isModifier": false,
"short": "Date last changed",
"mapping": [ {
"map": "FiveWs.recorded",
"identity": "w5"
} ],
"type": [ {
"code": "dateTime"
} ],
"mustSupport": false,
"alias": [ "Revision Date" ],
"max": "1",
"id": "FeatureDefinition.date",
"comment": "The date is often not tracked until the resource is published, but may be present on draft content. Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the {{title}}. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.\n\nSee guidance around (not) making local changes to elements [here](http://hl7.org/fhir/R5/canonicalresource.html#localization).",
"base": {
"max": "1",
"min": 0,
"path": "CanonicalResource.date"
},
"isSummary": true
}, {
"path": "FeatureDefinition.publisher",
"requirements": "Helps establish the \"authority/credibility\" of the {{title}}. May also allow for contact.",
"min": 0,
"definition": "The name of the organization or individual responsible for the release and ongoing maintenance of the {{title}}.",
"isModifier": false,
"short": "Name of the publisher/steward (organization or individual)",
"mapping": [ {
"map": "FiveWs.witness",
"identity": "w5"
} ],
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"max": "1",
"id": "FeatureDefinition.publisher",
"comment": "Usually an organization but may be an individual. The publisher (or steward) of the {{title}} is the organization or individual primarily responsible for the maintenance and upkeep of the {{title}}. 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 {{title}}. This item SHOULD be populated unless the information is available from context.",
"base": {
"max": "1",
"min": 0,
"path": "CanonicalResource.publisher"
},
"isSummary": true
}, {
"path": "FeatureDefinition.contact",
"min": 0,
"definition": "Contact details to assist a user in finding and communicating with the publisher.",
"isModifier": false,
"short": "Contact details for the publisher",
"type": [ {
"code": "ContactDetail"
} ],
"mustSupport": false,
"max": "*",
"id": "FeatureDefinition.contact",
"comment": "May be a web site, an email address, a telephone number, etc.\n\nSee guidance around (not) making local changes to elements [here](http://hl7.org/fhir/R5/canonicalresource.html#localization).",
"base": {
"max": "*",
"min": 0,
"path": "CanonicalResource.contact"
},
"isSummary": true
}, {
"path": "FeatureDefinition.description",
"min": 0,
"definition": "A free text natural language description of the {{title}} from a consumer's perspective.",
"isModifier": false,
"short": "Natural language description of the {{title}}",
"type": [ {
"code": "markdown"
} ],
"mustSupport": false,
"max": "1",
"id": "FeatureDefinition.description",
"comment": "This description can be used to capture details such as comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the {{title}} as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context.",
"base": {
"max": "1",
"min": 0,
"path": "CanonicalResource.description"
},
"isSummary": false
}, {
"path": "FeatureDefinition.useContext",
"requirements": "Assist in searching for appropriate content.",
"min": 0,
"definition": "The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate {{title}}s.",
"isModifier": false,
"short": "The context that the content is intended to support",
"type": [ {
"code": "UsageContext"
} ],
"mustSupport": false,
"max": "*",
"id": "FeatureDefinition.useContext",
"comment": "When multiple useContexts are specified, there is no expectation that all or even any of the contexts apply.",
"base": {
"max": "*",
"min": 0,
"path": "CanonicalResource.useContext"
},
"isSummary": true
}, {
"path": "FeatureDefinition.jurisdiction",
"min": 0,
"definition": "A legal or geographic region in which the {{title}} is intended to be used.",
"isModifier": false,
"short": "Intended jurisdiction for {{title}} (if applicable)",
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": false,
"binding": {
"strength": "extensible",
"valueSet": "http://hl7.org/fhir/ValueSet/jurisdiction|5.0.0",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Jurisdiction"
} ],
"description": "Countries and regions within which this artifact is targeted for use."
},
"max": "*",
"id": "FeatureDefinition.jurisdiction",
"comment": "It may be possible for the {{title}} to be used in jurisdictions other than those for which it was originally designed or intended.\n\nDEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'jurisdiction' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#jurisdiction and useContext.valueCodeableConcept indicating the jurisdiction.)",
"base": {
"max": "*",
"min": 0,
"path": "CanonicalResource.jurisdiction"
},
"isSummary": true
}, {
"path": "FeatureDefinition.purpose",
"min": 0,
"definition": "Explanation of why this {{title}} is needed and why it has been designed as it has.",
"isModifier": false,
"short": "Why this {{title}} is defined",
"mapping": [ {
"map": "FiveWs.why[x]",
"identity": "w5"
}, {
"map": "no-gen-base",
"identity": "objimpl"
} ],
"type": [ {
"code": "markdown"
} ],
"mustSupport": false,
"max": "1",
"id": "FeatureDefinition.purpose",
"comment": "This element does not describe the usage of the {{title}}. Instead, it provides traceability of \"why\" the resource is either needed or \"why\" it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this {{title}}.",
"base": {
"max": "1",
"min": 0,
"path": "CanonicalResource.purpose"
},
"isSummary": false
}, {
"path": "FeatureDefinition.copyright",
"requirements": "Consumers must be able to determine any legal restrictions on the use of the {{title}} and/or its content.",
"min": 0,
"definition": "A copyright statement relating to the {{title}} and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the {{title}}.",
"isModifier": false,
"short": "Use and/or publishing restrictions",
"mapping": [ {
"map": "no-gen-base",
"identity": "objimpl"
} ],
"type": [ {
"code": "markdown"
} ],
"mustSupport": false,
"alias": [ "License", "Restrictions" ],
"max": "1",
"id": "FeatureDefinition.copyright",
"comment": "The short copyright declaration (e.g. (c) '2015+ xyz organization' should be sent in the copyrightLabel element.",
"base": {
"max": "1",
"min": 0,
"path": "CanonicalResource.copyright"
},
"isSummary": false
}, {
"path": "FeatureDefinition.copyrightLabel",
"requirements": "Defines the content expected to be rendered in all representations of the artifact.",
"min": 0,
"definition": "A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved').",
"isModifier": false,
"short": "Copyright holder and year(s)",
"type": [ {
"code": "string"
} ],
"mustSupport": false,
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "FeatureDefinition.copyrightLabel",
"comment": "The (c) symbol should NOT be included in this string. It will be added by software when rendering the notation. Full details about licensing, restrictions, warrantees, etc. goes in the more general 'copyright' element.",
"base": {
"max": "1",
"min": 0,
"path": "CanonicalResource.copyrightLabel"
},
"isSummary": false
}, {
"id": "FeatureDefinition.valueType",
"max": "1",
"min": 1,
"path": "FeatureDefinition.valueType",
"type": [ {
"code": "code"
} ],
"short": "Type of value associated with the feature",
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/data-types"
},
"definition": "Features are very boolean: true or false for whether the application implements the feature, but the value \nassociated with the feature might be a number, a string, or some kind of code"
}, {
"id": "FeatureDefinition.valueSet",
"max": "1",
"min": 0,
"path": "FeatureDefinition.valueSet",
"type": [ {
"code": "canonical",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/ValueSet" ]
} ],
"short": "ValueSet that controls what coded value are allowed",
"definition": "If a value set is specified, the value of the data type must come from the value set, and the \nvalue type must be one of the bindeable types defined in the FHIR specification"
}, {
"id": "FeatureDefinition.contextDefinition",
"max": "1",
"min": 1,
"path": "FeatureDefinition.contextDefinition",
"type": [ {
"code": "markdown"
} ],
"short": "Human readable documentation describing how to interpret the context fields",
"definition": "The contextDefinition provides human readable documentation describing how to interpret the context fields. "
}, {
"id": "FeatureDefinition.contextExpressionLanguage",
"max": "1",
"min": 0,
"path": "FeatureDefinition.contextExpressionLanguage",
"type": [ {
"code": "code"
} ],
"short": "The mime type of context, if context uses an expression language",
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/mimetypes"
},
"definition": "The contextExpressionLanguage specifies the mime type of context, if context uses an expression language."
}, {
"id": "FeatureDefinition.context",
"max": "*",
"min": 0,
"path": "FeatureDefinition.context",
"type": [ {
"code": "string"
} ],
"short": "The context(s) on which this feature can be defined",
"definition": "The context(s) on which this feature can be defined. This is used to state where the feature applies. some\nfeatures are defined on applications, but others apply to particular resources, or operations on resources, or particular\ncode systems etc"
}, {
"id": "FeatureDefinition.qualifier",
"max": "*",
"min": 0,
"path": "FeatureDefinition.qualifier",
"type": [ {
"code": "BackboneElement"
} ],
"short": "A qualifier that might provided more information about a feature implementation",
"definition": "A qualifier is an extra piece of information that MAY or SHALL be provided when the feature is described/specified \nthat provides additional information about the feature. E.g. a feature defined on a resource may only be applicable \nto particular events associated with the resource, or ...?"
}, {
"id": "FeatureDefinition.qualifier.name",
"max": "1",
"min": 1,
"path": "FeatureDefinition.qualifier.name",
"type": [ {
"code": "code"
} ],
"short": "The name of the feature",
"definition": "The name of the feature"
}, {
"id": "FeatureDefinition.qualifier.description",
"max": "1",
"min": 0,
"path": "FeatureDefinition.qualifier.description",
"type": [ {
"code": "string"
} ],
"short": "A human-readable description of the qualifier.",
"definition": "A human-readable description of the qualifier."
}, {
"id": "FeatureDefinition.qualifier.valueType",
"max": "1",
"min": 1,
"path": "FeatureDefinition.qualifier.valueType",
"type": [ {
"code": "code"
} ],
"short": "Type of value associated with the feature",
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/data-types"
},
"definition": "Features are very boolean: true or false for whether the application implements the feature, but the value \nassociated with the feature might be a number, a string, or some kind of code"
}, {
"id": "FeatureDefinition.qualifier.optional",
"max": "1",
"min": 1,
"path": "FeatureDefinition.qualifier.optional",
"type": [ {
"code": "boolean"
} ],
"short": "Whether the feature is optional, or must always be present",
"definition": "Whether the feature is optional, or must always be present when a feature is referred to "
} ]
},
"contact": [ {
"name": "HL7 International / FHIR Infrastructure",
"telecom": [ {
"value": "http://www.hl7.org/Special/committees/fiwg",
"system": "url"
} ]
} ],
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/DomainResource"
}