Generated Narrative: StructureDefinition ext-R5-Requirements Name Flags Card. Type Description & Constraints Extension 0..* Extension(4.3.0) A set of requirements - features of systems that are necessary #xD; Slices for extension 1..* Extension Extension Slice: Unordered, Closed by value:url #xD; <a href="StructureDefinition-ext-R5-Requirements-definitions.html#Extension.extension:url" title="Slice url: An absolute URI that is used to identify this Requirements 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 Requirements is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the Requirements is stored on different servers.">extension:url 0..1 Extension Canonical identifier for this Requirements, represented as a URI (globally unique) #xD; url 1..1 uri "url" #xD; <a href="StructureDefinition-ext-R5-Requirements-definitions.html#Extension.extension:url.value[x]" title="An absolute URI that is used to identify this Requirements 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 Requirements is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the Requirements is stored on different servers.">value[x] 0..1 uri Canonical identifier for this Requirements, represented as a URI (globally unique) #xD; <a href="StructureDefinition-ext-R5-Requirements-definitions.html#Extension.extension:version" title="Slice version: The identifier that is used to identify this version of the Requirements when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the Requirements 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.">extension:version 0..1 Extension Business version of the Requirements #xD; url 1..1 uri "version" #xD; <a href="StructureDefinition-ext-R5-Requirements-definitions.html#Extension.extension:version.value[x]" title="The identifier that is used to identify this version of the Requirements when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the Requirements 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.">value[x] 0..1 string Business version of the Requirements #xD; extension:versionAlgorithm[x] 0..1 Extension How to compare versions #xD; url 1..1 uri "versionAlgorithm[x]" #xD; value[x] 0..1 How to compare versions Binding: R5_version_algorithm_for_R4B (0.0.1-snapshot-2) (extensible) #xD; valueString string #xD; valueCoding Coding #xD; extension:name 0..1 Extension Name for this Requirements (computer friendly) #xD; url 1..1 uri "name" #xD; value[x] 0..1 string Name for this Requirements (computer friendly) #xD; extension:title 0..1 Extension Name for this Requirements (human friendly) #xD; url 1..1 uri "title" #xD; value[x] 0..1 string Name for this Requirements (human friendly) #xD; extension:status 1..1 Extension draft | active | retired | unknown #xD; url 1..1 uri "status" #xD; value[x] 0..1 code draft | active | retired | unknown Binding: R5_publication_status_for_R4B (0.0.1-snapshot-2) (required): The lifecycle status of an artifact. #xD; extension:experimental 0..1 Extension For testing purposes, not real usage #xD; url 1..1 uri "experimental" #xD; value[x] 0..1 boolean For testing purposes, not real usage #xD; extension:date 0..1 Extension Date last changed #xD; url 1..1 uri "date" #xD; value[x] 0..1 dateTime Date last changed #xD; extension:publisher 0..1 Extension Name of the publisher/steward (organization or individual) #xD; url 1..1 uri "publisher" #xD; value[x] 0..1 string Name of the publisher/steward (organization or individual) #xD; extension:contact 0..* Extension Contact details for the publisher #xD; url 1..1 uri "contact" #xD; value[x] 0..1 ContactDetail Contact details for the publisher #xD; extension:description 0..1 Extension Natural language description of the requirements #xD; url 1..1 uri "description" #xD; value[x] 0..1 markdown Natural language description of the requirements #xD; <a href="StructureDefinition-ext-R5-Requirements-definitions.html#Extension.extension:useContext" title="Slice useContext: 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 Requirements instances.">extension:useContext 0..* Extension The context that the content is intended to support #xD; url 1..1 uri "useContext" #xD; <a href="StructureDefinition-ext-R5-Requirements-definitions.html#Extension.extension:useContext.value[x]" title="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 Requirements instances.">value[x] 0..1 UsageContext The context that the content is intended to support #xD; extension:jurisdiction 0..* Extension Intended jurisdiction for Requirements (if applicable) #xD; url 1..1 uri "jurisdiction" #xD; value[x] 0..1 CodeableConcept Intended jurisdiction for Requirements (if applicable) Binding: R5_jurisdiction_for_R4B (0.0.1-snapshot-2) (extensible): Countries and regions within which this artifact is targeted for use. #xD; extension:purpose 0..1 Extension Why this Requirements is defined #xD; url 1..1 uri "purpose" #xD; value[x] 0..1 markdown Why this Requirements is defined #xD; extension:copyright 0..1 Extension Use and/or publishing restrictions #xD; url 1..1 uri "copyright" #xD; value[x] 0..1 markdown Use and/or publishing restrictions #xD; <a href="StructureDefinition-ext-R5-Requirements-definitions.html#Extension.extension:copyrightLabel" title="Slice copyrightLabel: 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').">extension:copyrightLabel 0..1 Extension Copyright holder and year(s) #xD; url 1..1 uri "copyrightLabel" #xD; <a href="StructureDefinition-ext-R5-Requirements-definitions.html#Extension.extension:copyrightLabel.value[x]" title="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').">value[x] 0..1 string Copyright holder and year(s) #xD; extension:derivedFrom 0..* Extension Other set of Requirements this builds on #xD; url 1..1 uri "derivedFrom" #xD; value[x] 0..1 canonical() Other set of Requirements this builds on #xD; extension:reference 0..* Extension External artifact (rule/document etc. that) created this set of requirements #xD; url 1..1 uri "reference" #xD; value[x] 0..1 url External artifact (rule/document etc. that) created this set of requirements #xD; extension:actor 0..* Extension Actor for these requirements #xD; url 1..1 uri "actor" #xD; value[x] 0..1 canonical() Actor for these requirements #xD; extension:statement 0..* Extension Actual statement as markdown #xD; Slices for extension 2..* Extension Extension Slice: Unordered, Closed by value:url #xD; extension:key 1..1 Extension Key that identifies this statement #xD; url 1..1 uri "key" #xD; value[x] 0..1 id Key that identifies this statement #xD; extension:label 0..1 Extension Short Human label for this statement #xD; url 1..1 uri "label" #xD; value[x] 0..1 string Short Human label for this statement #xD; extension:conformance 0..* Extension SHALL | SHOULD | MAY | SHOULD-NOT #xD; url 1..1 uri "conformance" #xD; value[x] 0..1 code SHALL | SHOULD | MAY | SHOULD-NOT Binding: R5_conformance_expectation_for_R4B (0.0.1-snapshot-2) (required) #xD; extension:conditionality 0..1 Extension Set to true if requirements statement is conditional #xD; url 1..1 uri "conditionality" #xD; value[x] 0..1 boolean Set to true if requirements statement is conditional #xD; extension:requirement 1..1 Extension The actual requirement #xD; url 1..1 uri "requirement" #xD; value[x] 0..1 markdown The actual requirement #xD; extension:derivedFrom 0..1 Extension Another statement this clarifies/restricts ([url#]key) #xD; url 1..1 uri "derivedFrom" #xD; value[x] 0..1 string Another statement this clarifies/restricts ([url#]key) #xD; extension:parent 0..1 Extension A larger requirement that this requirement helps to refine and enable #xD; url 1..1 uri "parent" #xD; value[x] 0..1 string A larger requirement that this requirement helps to refine and enable #xD; extension:satisfiedBy 0..* Extension Design artifact that satisfies this requirement #xD; url 1..1 uri "satisfiedBy" #xD; value[x] 0..1 url Design artifact that satisfies this requirement #xD; extension:reference 0..* Extension External artifact (rule/document etc. that) created this requirement #xD; url 1..1 uri "reference" #xD; value[x] 0..1 url External artifact (rule/document etc. that) created this requirement #xD; extension:source 0..* Extension Who asked for this statement #xD; url 1..1 uri "source" #xD; value[x] 0..1 Reference() Who asked for this statement #xD; url 1..1 uri "statement" #xD; url 1..1 uri "http://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements" #xD; Documentation for this format
Cross-version Extension for R5.Requirements for use in FHIR R4B
This cross-version extension represents Requirements from http://hl7.org/fhir/StructureDefinition/Requirements|5.0.0 for use in FHIR R4B.
A set of requirements - features of systems that are necessary
A set of requirements - a list of features or behaviors of designed systems that are necessary to achieve organizational or regulatory goals.
All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
Must have either extensions or value[x], not both
exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Extensions are always sliced by (at least) url
All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])
Canonical identifier for this Requirements, represented as a URI (globally unique)
An absolute URI that is used to identify this Requirements 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 Requirements is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the Requirements is stored on different servers.
Additional content defined by implementations
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.
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.
Source of the definition for the extension code - a logical name or a URL.
The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
The identifier that is used to identify this version of the Requirements when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the Requirements 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.
Indicates the mechanism used to compare versions to determine which is more current.
Name for this Requirements (computer friendly)
A natural language name identifying the Requirements. This name should be usable as an identifier for the module by machine processing applications such as code generation.
Name for this Requirements (human friendly)
A short, descriptive, user-friendly title for the Requirements.
The status of this Requirements. Enables tracking the life-cycle of the content.
A Boolean value to indicate that this Requirements is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.
The date (and optionally time) when the Requirements 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 Requirements changes.
Name of the publisher/steward (organization or individual)
The name of the organization or individual responsible for the release and ongoing maintenance of the Requirements.
Contact details to assist a user in finding and communicating with the publisher.
Natural language description of the requirements
A free text natural language description of the requirements.
The context that the content is intended to support
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 Requirements instances.
Intended jurisdiction for Requirements (if applicable)
A legal or geographic region in which the Requirements is intended to be used.
Countries and regions within which this artifact is targeted for use.
Explanation of why this Requirements is needed and why it has been designed as it has.
A copyright statement relating to the Requirements and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the Requirements.
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').
Other set of Requirements this builds on
Another set of Requirements that this set of Requirements builds on and updates.
External artifact (rule/document etc. that) created this set of requirements
A reference to another artifact that created this set of requirements. This could be a Profile, etc., or external regulation, or business requirements expressed elsewhere.
An actor these requirements are in regard to.
The actual statement of requirement, in markdown format.
Key that identifies this statement (unique within this resource).
A short human usable label for this statement.
Set to true if requirements statement is conditional
This boolean flag is set to true of the text of the requirement is conditional on something e.g. it includes lanauage like 'if x then y'. This conditionality flag is introduced for purposes of filtering and colour highlighting etc.
The actual requirement for human consumption.
Another statement this clarifies/restricts ([url#]key)
Another statement on one of the requirements that this requirement clarifies or restricts.
A larger requirement that this requirement helps to refine and enable
This cross-version extension represents Requirements.statement.parent from http://hl7.org/fhir/StructureDefinition/Requirements|5.0.0 for use in FHIR R4B.
Design artifact that satisfies this requirement
A reference to another artifact that satisfies this requirement. This could be a Profile, extension, or an element in one of those, or a CapabilityStatement, OperationDefinition, SearchParameter, CodeSystem(/code), ValueSet, Libary etc.
External artifact (rule/document etc. that) created this requirement
A reference to another artifact that created this requirement. This could be a Profile, etc., or external regulation, or business requirements expressed elsewhere.
Who asked for this statement to be a requirement. By default, it's assumed that the publisher knows who it is if it matters.
Value of extension - must be one of a constrained set of the data types (see [Extensibility](http://hl7.org/fhir/R4B/extensibility.html) for a list).