This page is part of the FHIR Specification v6.0.0-ballot1: Release 6 Ballot (1st Draft) (see Ballot Notes). The current version is 5.0.0. For a full list of available versions, see the Directory of published versions
FHIR Infrastructure Work Group | Maturity Level: 1 | Trial Use | Security Category: Anonymous | Compartments: No defined compartments |
Detailed Descriptions for the elements in the Requirements resource.
Requirements | |||||||||
Element Id | Requirements | ||||||||
Definition | A set of requirements - a list of features or behaviors of designed systems that are necessary to achieve organizational or regulatory goals. | ||||||||
Short Display | A set of requirements - features of systems that are necessary | ||||||||
Cardinality | 0..* | ||||||||
Type | CanonicalResource | ||||||||
Summary | false | ||||||||
Invariants |
| ||||||||
Requirements.url | |||||||||
Element Id | Requirements.url | ||||||||
Definition | 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. | ||||||||
Short Display | Canonical identifier for this Requirements, represented as a URI (globally unique) | ||||||||
Cardinality | 0..1 | ||||||||
Type | uri | ||||||||
Requirements | Allows the Requirements to be referenced by a single globally unique identifier. | ||||||||
Summary | true | ||||||||
Comments | 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. The 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. In 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 element to indicate where the current master source of the resource can be found. | ||||||||
Invariants |
| ||||||||
Requirements.identifier | |||||||||
Element Id | Requirements.identifier | ||||||||
Definition | A formal identifier that is used to identify this Requirements when it is represented in other formats, or referenced in a specification, model, design or an instance. | ||||||||
Short Display | Additional identifier for the Requirements (business identifier) | ||||||||
Note | This is a business identifier, not a resource identifier (see discussion) | ||||||||
Cardinality | 0..* | ||||||||
Type | Identifier | ||||||||
Requirements | Allows externally provided and/or usable business identifiers to be easily associated with the module. | ||||||||
Summary | true | ||||||||
Requirements.version | |||||||||
Element Id | Requirements.version | ||||||||
Definition | 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. | ||||||||
Short Display | Business version of the Requirements | ||||||||
Note | This is a business versionId, not a resource version id (see discussion) | ||||||||
Cardinality | 0..1 | ||||||||
Type | string | ||||||||
Summary | true | ||||||||
Comments | There may be different Requirements 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 Requirements with the format [url]|[version]. The version SHOULD NOT contain a '#' - see Business Version. | ||||||||
Requirements.versionAlgorithm[x] | |||||||||
Element Id | Requirements.versionAlgorithm[x] | ||||||||
Definition | Indicates the mechanism used to compare versions to determine which is more current. | ||||||||
Short Display | How to compare versions | ||||||||
Cardinality | 0..1 | ||||||||
Terminology Binding | Version Algorithm (Extensible) | ||||||||
Type | string|Coding | ||||||||
[x] Note | See Choice of Datatypes for further information about how to use [x] | ||||||||
Summary | true | ||||||||
Comments | 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. | ||||||||
Requirements.name | |||||||||
Element Id | Requirements.name | ||||||||
Definition | 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. | ||||||||
Short Display | Name for this Requirements (computer friendly) | ||||||||
Cardinality | 0..1 | ||||||||
Type | string | ||||||||
Requirements | Support human navigation and code generation. | ||||||||
Summary | true | ||||||||
Comments | 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. | ||||||||
Invariants |
| ||||||||
Requirements.title | |||||||||
Element Id | Requirements.title | ||||||||
Definition | A short, descriptive, user-friendly title for the Requirements. | ||||||||
Short Display | Name for this Requirements (human friendly) | ||||||||
Cardinality | 0..1 | ||||||||
Type | string | ||||||||
Summary | true | ||||||||
Comments | This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc. | ||||||||
Requirements.status | |||||||||
Element Id | Requirements.status | ||||||||
Definition | The status of this Requirements. Enables tracking the life-cycle of the content. | ||||||||
Short Display | draft | active | retired | unknown | ||||||||
Cardinality | 1..1 | ||||||||
Terminology Binding | PublicationStatus (Required) | ||||||||
Type | code | ||||||||
Is Modifier | true (Reason: This is labeled as "Is Modifier" because designs and applications should not use a retired Requirements without due consideration) | ||||||||
Summary | true | ||||||||
Comments | Allows filtering of Requirements that are appropriate for use versus not. See guidance around (not) making local changes to elements here. | ||||||||
Requirements.experimental | |||||||||
Element Id | Requirements.experimental | ||||||||
Definition | 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. | ||||||||
Short Display | For testing purposes, not real usage | ||||||||
Cardinality | 0..1 | ||||||||
Type | boolean | ||||||||
Meaning if Missing | If absent, this resource is treated as though it is not experimental. | ||||||||
Requirements | Enables experimental content to be developed following the same lifecycle that would be used for a production-level Requirements. | ||||||||
Summary | true | ||||||||
Comments | Allows filtering of Requirements that are appropriate for use versus not. | ||||||||
Requirements.date | |||||||||
Element Id | Requirements.date | ||||||||
Definition | 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. | ||||||||
Short Display | Date last changed | ||||||||
Cardinality | 0..1 | ||||||||
Type | dateTime | ||||||||
Alternate Names | Revision Date | ||||||||
Summary | true | ||||||||
Comments | Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the Requirements. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource. See guidance around (not) making local changes to elements here. | ||||||||
Requirements.publisher | |||||||||
Element Id | Requirements.publisher | ||||||||
Definition | The name of the organization or individual responsible for the release and ongoing maintenance of the Requirements. | ||||||||
Short Display | Name of the publisher/steward (organization or individual) | ||||||||
Cardinality | 0..1 | ||||||||
Type | string | ||||||||
Requirements | Helps establish the "authority/credibility" of the Requirements. May also allow for contact. | ||||||||
Summary | true | ||||||||
Comments | Usually an organization but may be an individual. The publisher (or steward) of the Requirements is the organization or individual primarily responsible for the maintenance and upkeep of the Requirements. 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 Requirements. This item SHOULD be populated unless the information is available from context. | ||||||||
Requirements.contact | |||||||||
Element Id | Requirements.contact | ||||||||
Definition | Contact details to assist a user in finding and communicating with the publisher. | ||||||||
Short Display | Contact details for the publisher | ||||||||
Cardinality | 0..* | ||||||||
Type | ContactDetail | ||||||||
Summary | true | ||||||||
Comments | May be a web site, an email address, a telephone number, etc. See guidance around (not) making local changes to elements here. | ||||||||
Requirements.description | |||||||||
Element Id | Requirements.description | ||||||||
Definition | A free text natural language description of the requirements. | ||||||||
Short Display | Natural language description of the requirements | ||||||||
Cardinality | 0..1 | ||||||||
Type | markdown | ||||||||
Alternate Names | Scope; Purpose | ||||||||
Summary | false | ||||||||
Comments | This description can be used for a general description of the requirements, and which covers why it was defined. | ||||||||
Requirements.useContext | |||||||||
Element Id | Requirements.useContext | ||||||||
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 Requirements instances. | ||||||||
Short Display | The context that the content is intended to support | ||||||||
Cardinality | 0..* | ||||||||
Type | UsageContext | ||||||||
Requirements | Assist in searching for appropriate content. | ||||||||
Summary | true | ||||||||
Comments | When multiple useContexts are specified, there is no expectation that all or any of the contexts apply. | ||||||||
Requirements.jurisdiction | |||||||||
Standards Status | This element has a standards status of "Deprecated" which is different from the status of the whole resource | ||||||||
Element Id | Requirements.jurisdiction | ||||||||
Definition | A legal or geographic region in which the Requirements is intended to be used. | ||||||||
Short Display | Intended jurisdiction for Requirements (if applicable) | ||||||||
Cardinality | 0..* | ||||||||
Terminology Binding | Jurisdiction ValueSet (Extensible) | ||||||||
Type | CodeableConcept | ||||||||
Summary | true | ||||||||
Comments | It may be possible for the Requirements to be used in jurisdictions other than those for which it was originally designed or intended DEPRECATION 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.). | ||||||||
Requirements.purpose | |||||||||
Element Id | Requirements.purpose | ||||||||
Definition | Explanation of why this Requirements is needed and why it has been designed as it has. | ||||||||
Short Display | Why this Requirements is defined | ||||||||
Cardinality | 0..1 | ||||||||
Type | markdown | ||||||||
Summary | false | ||||||||
Comments | This element does not describe the usage of the Requirements. 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 Requirements. | ||||||||
Requirements.copyright | |||||||||
Element Id | Requirements.copyright | ||||||||
Definition | 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. | ||||||||
Short Display | Use and/or publishing restrictions | ||||||||
Cardinality | 0..1 | ||||||||
Type | markdown | ||||||||
Requirements | Consumers must be able to determine any legal restrictions on the use of the Requirements. | ||||||||
Alternate Names | License; Restrictions | ||||||||
Summary | false | ||||||||
Comments | ... | ||||||||
Requirements.copyrightLabel | |||||||||
Element Id | Requirements.copyrightLabel | ||||||||
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'). | ||||||||
Short Display | Copyright holder and year(s) | ||||||||
Cardinality | 0..1 | ||||||||
Type | string | ||||||||
Requirements | Defines the content expected to be rendered in all representations of the artifact. | ||||||||
Summary | false | ||||||||
Comments | 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. | ||||||||
Requirements.derivedFrom | |||||||||
Element Id | Requirements.derivedFrom | ||||||||
Definition | Another set of Requirements that this set of Requirements builds on and updates. | ||||||||
Short Display | Other set of Requirements this builds on | ||||||||
Cardinality | 0..* | ||||||||
Type | canonical(Requirements) | ||||||||
Summary | true | ||||||||
Comments | Existing statements (by key) may be narrowed or clarified, and additional statements added. | ||||||||
Requirements.reference | |||||||||
Element Id | Requirements.reference | ||||||||
Definition | 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. | ||||||||
Short Display | External artifact (rule/document etc. that) created this set of requirements | ||||||||
Cardinality | 0..* | ||||||||
Type | url | ||||||||
Summary | false | ||||||||
Requirements.actor | |||||||||
Element Id | Requirements.actor | ||||||||
Definition | An actor these requirements are in regard to. | ||||||||
Short Display | Actor for these requirements | ||||||||
Cardinality | 0..* | ||||||||
Type | canonical(ActorDefinition) | ||||||||
Summary | false | ||||||||
Comments | If more than one actor is specified, then it's up to the statements to describe in narrative if they don't apply to all actors. | ||||||||
Requirements.statement | |||||||||
Element Id | Requirements.statement | ||||||||
Definition | The actual statement of requirement, in markdown format. | ||||||||
Short Display | Actual statement as markdown | ||||||||
Cardinality | 0..* | ||||||||
Summary | false | ||||||||
Requirements.statement.key | |||||||||
Element Id | Requirements.statement.key | ||||||||
Definition | Key that identifies this statement (unique within this resource). | ||||||||
Short Display | Key that identifies this statement | ||||||||
Cardinality | 1..1 | ||||||||
Type | id | ||||||||
Summary | false | ||||||||
Comments | Refer directly to the statement by {url}#{key} | ||||||||
Requirements.statement.label | |||||||||
Element Id | Requirements.statement.label | ||||||||
Definition | A short human usable label for this statement. | ||||||||
Short Display | Short Human label for this statement | ||||||||
Cardinality | 0..1 | ||||||||
Type | string | ||||||||
Summary | false | ||||||||
Comments | The key is intended for computers, while this is intended for humans. In its absence, the key should be convenient for a human to say (e.g. not a UUID) | ||||||||
Requirements.statement.conformance | |||||||||
Element Id | Requirements.statement.conformance | ||||||||
Definition | A short human usable label for this statement. | ||||||||
Short Display | SHALL | SHOULD | MAY | SHOULD-NOT | ||||||||
Cardinality | 0..* | ||||||||
Terminology Binding | Conformance Expectation (Required) | ||||||||
Type | code | ||||||||
Requirements | This element is allowed to repeat because a single requirements statement might contain multiple conformance words and thus need to be indexed under multiple conformance categories. | ||||||||
Summary | false | ||||||||
Comments | The conformance code is extracted from the requirement to make indexing and display easier. The requirement needs to express the conformance verbs directly in the markdown content. It's not unusual to mix verbs in a single sentence (e.g. System SHALL do X and SHOULD do Y) | ||||||||
Requirements.statement.conditionality | |||||||||
Element Id | Requirements.statement.conditionality | ||||||||
Definition | 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. | ||||||||
Short Display | Set to true if requirements statement is conditional | ||||||||
Cardinality | 0..1 | ||||||||
Type | boolean | ||||||||
Summary | false | ||||||||
Comments | There is no intent that the conditional statement by evaluatable | ||||||||
Requirements.statement.requirement | |||||||||
Element Id | Requirements.statement.requirement | ||||||||
Definition | The actual requirement for human consumption. | ||||||||
Short Display | The actual requirement | ||||||||
Cardinality | 1..1 | ||||||||
Type | markdown | ||||||||
Summary | false | ||||||||
Requirements.statement.derivedFrom | |||||||||
Element Id | Requirements.statement.derivedFrom | ||||||||
Definition | Another statement on one of the requirements that this requirement clarifies or restricts. | ||||||||
Short Display | Another statement this clarifies/restricts ([url#]key) | ||||||||
Cardinality | 0..1 | ||||||||
Type | string | ||||||||
Summary | false | ||||||||
Comments | This can be just a key, if there is only one matching statement in the requirements statements referenced in Requirements.derivedFrom. If there is more than one, it should be in the format | ||||||||
Requirements.statement.parent | |||||||||
Element Id | Requirements.statement.parent | ||||||||
Definition | A larger requirement that this requirement helps to refine and enable. | ||||||||
Short Display | A larger requirement that this requirement helps to refine and enable | ||||||||
Cardinality | 0..1 | ||||||||
Type | string | ||||||||
Requirements | Allows requirements to be organized compositionally. E.g. Epic/Story/Task. | ||||||||
Summary | false | ||||||||
Comments | Follows the same convention as statement.derivedFrom, where a reference is the canonical of the Requirements followed by '#' and the 'key' of the specific requirement. | ||||||||
Requirements.statement.satisfiedBy | |||||||||
Element Id | Requirements.statement.satisfiedBy | ||||||||
Definition | 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. | ||||||||
Short Display | Design artifact that satisfies this requirement | ||||||||
Cardinality | 0..* | ||||||||
Type | url | ||||||||
Summary | false | ||||||||
Comments | This is for use when the requirement is met be a pre-existing artifact e.g. a rule that's met by the base FHIR spec, or a national implementation guide. | ||||||||
Requirements.statement.reference | |||||||||
Element Id | Requirements.statement.reference | ||||||||
Definition | A reference to another artifact that created this requirement. This could be a Profile, etc., or external regulation, or business requirements expressed elsewhere. | ||||||||
Short Display | External artifact (rule/document etc. that) created this requirement | ||||||||
Cardinality | 0..* | ||||||||
Type | url | ||||||||
Summary | false | ||||||||
Requirements.statement.source | |||||||||
Element Id | Requirements.statement.source | ||||||||
Definition | Who asked for this statement to be a requirement. By default, it's assumed that the publisher knows who it is if it matters. | ||||||||
Short Display | Who asked for this statement | ||||||||
Cardinality | 0..* | ||||||||
Type | Reference(CareTeam | Device | Group | HealthcareService | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) | ||||||||
Summary | false |