FHIR CI-Build

This is the Continuous Integration Build of FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions icon

FHIR Infrastructure icon Work GroupMaturity Level: 1 Trial UseSecurity Category: Anonymous Compartments: Not linked to any defined compartments

Detailed Descriptions for the elements in the Requirements resource.

Requirements
Element IdRequirements
Definition

A set of requirements - a list of features or behaviors of designed systems that are necessary to achieve organizational or regulatory goals.

Short DisplayA set of requirements - features of systems that are necessary
Cardinality0..*
TypeCanonicalResource
Summaryfalse
Invariants
Defined on this element
cnl-0Warning Name should be usable as an identifier for the module by machine processing applications such as code generationname.exists() implies name.matches('[A-Z]([A-Za-z0-9_]){1,254}')
Requirements.url
Element IdRequirements.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 DisplayCanonical identifier for this Requirements, represented as a URI (globally unique)
Cardinality0..1
Typeuri
Requirements

Allows the Requirements to be referenced by a single globally unique identifier.

Summarytrue
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
Defined on this element
cnl-1Warning URL should not contain | or # - these characters make processing canonical references problematicurl.matches('([^|#])*')
Requirements.identifier
Element IdRequirements.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 DisplayAdditional identifier for the Requirements (business identifier)
NoteThis is a business identifier, not a resource identifier (see discussion)
Cardinality0..*
TypeIdentifier
Requirements

Allows externally provided and/or usable business identifiers to be easily associated with the module.

Summarytrue
Requirements.version
Element IdRequirements.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 DisplayBusiness version of the Requirements
NoteThis is a business versionId, not a resource version id (see discussion)
Cardinality0..1
Typestring
Summarytrue
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.name
Element IdRequirements.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 DisplayName for this Requirements (computer friendly)
Cardinality0..1
Typestring
Requirements

Support human navigation and code generation.

Summarytrue
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
Affect this element
cnl-0Warning Name should be usable as an identifier for the module by machine processing applications such as code generationname.exists() implies name.matches('[A-Z]([A-Za-z0-9_]){1,254}')
Requirements.title
Element IdRequirements.title
Definition

A short, descriptive, user-friendly title for the Requirements.

Short DisplayName for this Requirements (human friendly)
Cardinality0..1
Typestring
Summarytrue
Comments

This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.

Requirements.status
Element IdRequirements.status
Definition

The status of this Requirements. Enables tracking the life-cycle of the content.

Short Displaydraft | active | retired | unknown
Cardinality1..1
Terminology BindingPublicationStatus (Required)
Typecode
Is Modifiertrue (Reason: This is labeled as "Is Modifier" because designs and applications should not use a retired Requirements without due consideration)
Summarytrue
Comments

Allows filtering of Requirements that are appropriate for use versus not.

Requirements.experimental
Element IdRequirements.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 DisplayFor testing purposes, not real usage
Cardinality0..1
Typeboolean
Meaning if MissingIf 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.

Summarytrue
Comments

Allows filtering of Requirements that are appropriate for use versus not.

Requirements.date
Element IdRequirements.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 DisplayDate last changed
Cardinality0..1
TypedateTime
Alternate NamesRevision Date
Summarytrue
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.

Requirements.publisher
Element IdRequirements.publisher
Definition

The name of the organization or individual responsible for the release and ongoing maintenance of the Requirements.

Short DisplayName of the publisher/steward (organization or individual)
Cardinality0..1
Typestring
Requirements

Helps establish the "authority/credibility" of the Requirements. May also allow for contact.

Summarytrue
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 IdRequirements.contact
Definition

Contact details to assist a user in finding and communicating with the publisher.

Short DisplayContact details for the publisher
Cardinality0..*
TypeContactDetail
Summarytrue
Comments

May be a web site, an email address, a telephone number, etc.

Requirements.description
Element IdRequirements.description
Definition

A free text natural language description of the actor.

Short DisplayNatural language description of the actor
Cardinality0..1
Typemarkdown
Alternate NamesScope; Purpose
Summaryfalse
Comments

This description can be used for a general description of the actor, and which covers why it was defined.

Requirements.useContext
Element IdRequirements.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 DisplayThe context that the content is intended to support
Cardinality0..*
TypeUsageContext
Requirements

Assist in searching for appropriate content.

Summarytrue
Comments

When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.

Requirements.jurisdiction
Element IdRequirements.jurisdiction
Definition

A legal or geographic region in which the Requirements is intended to be used.

Short DisplayIntended jurisdiction for Requirements (if applicable)
Cardinality0..*
Terminology BindingJurisdiction ValueSet (Extensible)
TypeCodeableConcept
Summarytrue
Comments

It may be possible for the Requirements to be used in jurisdictions other than those for which it was originally designed or intended.

Requirements.purpose
Element IdRequirements.purpose
Definition

Explanation of why this Requirements is needed and why it has been designed as it has.

Short DisplayWhy this Requirements is defined
Cardinality0..1
Typemarkdown
Summaryfalse
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 IdRequirements.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 DisplayUse and/or publishing restrictions
Cardinality0..1
Typemarkdown
Requirements

Consumers must be able to determine any legal restrictions on the use of the Requirements.

Alternate NamesLicense; Restrictions
Summaryfalse
Comments

...

Requirements.copyrightLabel
Element IdRequirements.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 DisplayCopyright holder and year(s)
Cardinality0..1
Typestring
Requirements

Defines the content expected to be rendered in all representations of the artifact.

Summaryfalse
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 IdRequirements.derivedFrom
Definition

Another set of Requirements that this set of Requirements builds on and updates.

Short DisplayOther set of Requirements this builds on
Cardinality0..*
Typecanonical(Requirements)
Summarytrue
Comments

Existing statements (by key) may be narrowed or clarified, and additional statements added.

Requirements.actor
Element IdRequirements.actor
Definition

An actor these requirements are in regard to.

Short DisplayActor for these requirements
Cardinality0..*
Typecanonical(ActorDefinition)
Summaryfalse
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 IdRequirements.statement
Definition

The actual statement of requirement, in markdown format.

Short DisplayActual statement as markdown
Cardinality0..*
Summaryfalse
Requirements.statement.key
Element IdRequirements.statement.key
Definition

Key that identifies this statement (unique within this resource).

Short DisplayKey that identifies this statement
Cardinality1..1
Typeid
Summaryfalse
Comments

Refer directly to the statement by {url}#{key}

Requirements.statement.label
Element IdRequirements.statement.label
Definition

A short human usable label for this statement.

Short DisplayShort Human label for this statement
Cardinality0..1
Typestring
Summaryfalse
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 IdRequirements.statement.conformance
Definition

A short human usable label for this statement.

Short DisplaySHALL | SHOULD | MAY | SHOULD-NOT
Cardinality0..*
Terminology BindingConformanceExpectation (Required)
Typecode
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.

Summaryfalse
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 IdRequirements.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 DisplaySet to true if requirements statement is conditional
Cardinality0..1
Typeboolean
Summaryfalse
Comments

There is no intent that the conditional statement by evaluatable

Requirements.statement.requirement
Element IdRequirements.statement.requirement
Definition

The actual requirement for human consumption.

Short DisplayThe actual requirement
Cardinality1..1
Typemarkdown
Summaryfalse
Requirements.statement.derivedFrom
Element IdRequirements.statement.derivedFrom
Definition

Another statement on one of the requirements that this requirement clarifies or restricts.

Short DisplayAnother statement this clarifies/restricts ([url#]key)
Cardinality0..1
Typestring
Summaryfalse
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 url#key

Requirements.statement.parent
Element IdRequirements.statement.parent
Definition

A larger requirement that this requirement helps to refine and enable.

Short DisplayA larger requirement that this requirement helps to refine and enable
Cardinality0..1
Typestring
Requirements

Allows requirements to be organized compositionally. E.g. Epic/Story/Task.

Summaryfalse
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 IdRequirements.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 DisplayDesign artifact that satisfies this requirement
Cardinality0..*
Typeurl
Summaryfalse
Comments

This is for use when the requirement is met be an pre-existing artifact e.g. a rule that's met by the base FHIR spec, or a national implementation guide.

Requirements.statement.reference
Element IdRequirements.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 DisplayExternal artifact (rule/document etc that) created this requirement
Cardinality0..*
Typeurl
Summaryfalse
Requirements.statement.source
Element IdRequirements.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 DisplayWho asked for this statement
Cardinality0..*
TypeReference(Practitioner | Organization | CareTeam | Group)
Summaryfalse