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

5.12 Resource Requirements - Content

FHIR Infrastructure icon

Work Group

Maturity Level: 1

Trial Use

Security Category: Anonymous

Compartments: No defined compartments

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

5.12.1 Scope and Usage

The Requirements Resource a set of statements that are requirements for some design artifact to meet. The requirements resource is intended to meet two principle use cases:

Documenting known regulatory, business, functional and technical requirements for interoperability specifications, particularly those published as Implementation Guides
Performing the same role for clinical processes as documented in PlanDefinition and ActivityDefinition

The Requirements Resource is focused on gathering known requirements and providing traceability from solutions to the requirements they are intended to meet.

In any set of requirements, some of them may already be met by preexisting specifications, while others are requirements that must be fulfilled by some specification or design that is created with or subsequent to the requirements. For this reason, requirements can directly identify features of specifications that satisfy the stated requirement, but in most cases, it is expected that the specifications and designs that meet the requirements will provice traceability to the requirement.

Each Requirements resource carries a set of statements about requirements. Each statement has:

identity: Computable and human identification of the statement
requirement: The wording of the requirement
conformance: The strength associated with the statement. The strength is almost always embedded in the language of the requirement, but this allows for filtering and a degree of automated processing
source: Source information about who was the source of the requirement
satisfied by: A reference to some pre-existing specification element that satisfies the requirement

5.12.2 Boundaries and Relationships

Requirements may by referenced from almost any resource by the Requirements Satisfied extension. Generally, this extension will be found in the Canonical Resources but this is not a hard rule.

If requirements are satisfied by an existing specification, they SHOULD reference a FHIR resource by {url} or a particular element by {url}#id, but the target of a reference does not need to be a resource at all.

The requirements resource carries minimal provenance information - the name of the publisher, and the source of the statements. Additional provenance information should be carried in a Provenance resource.

5.12.3 Background and Context

A number of stakeholders publishing FHIR implementation guides wish to do formal requirements tracing. This resource exists for them.

5.12.4 References to this Resource

Implements: Definition
Resource References: itself, TestReport and TestScript
Extension References: Requirements Parent and Resource Satisfies Requirement

Structure

Name	Flags	Card.	Type	Description & Constraints
Requirements	TU		DomainResource	A set of requirements - features of systems that are necessary + Warning: Name should be usable as an identifier for the module by machine processing applications such as code generation Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension Interfaces Implemented: CanonicalResource
url	Σ C	0..1	uri	Canonical identifier for this Requirements, represented as a URI (globally unique) + Warning: URL should not contain \| or # - these characters make processing canonical references problematic
identifier	Σ	0..*	Identifier	Additional identifier for the Requirements (business identifier)
version	Σ	0..1	string	Business version of the Requirements
versionAlgorithm[x]	Σ	0..1		How to compare versions Binding: Version Algorithm (Extensible)
versionAlgorithmString			string
versionAlgorithmCoding			Coding
name	Σ C	0..1	string	Name for this Requirements (computer friendly)
title	Σ T	0..1	string	Name for this Requirements (human friendly)
status	?!Σ	1..1	code	draft \| active \| retired \| unknown Binding: PublicationStatus (Required)
experimental	Σ	0..1	boolean	For testing purposes, not real usage
date	Σ	0..1	dateTime	Date last changed
publisher	Σ T	0..1	string	Name of the publisher/steward (organization or individual)
contact	Σ	0..*	ContactDetail	Contact details for the publisher
description	T	0..1	markdown	Natural language description of the requirements
useContext	Σ TU	0..*	UsageContext	The context that the content is intended to support
jurisdiction	Σ XD	0..*	CodeableConcept	Intended jurisdiction for Requirements (if applicable) Binding: Jurisdiction ValueSet (Extensible)
purpose	T	0..1	markdown	Why this Requirements is defined
copyright	T	0..1	markdown	Use and/or publishing restrictions
copyrightLabel	T	0..1	string	Copyright holder and year(s)
derivedFrom	Σ	0..*	canonical(Requirements)	Other set of Requirements this builds on
reference		0..*	url	External artifact (rule/document etc. that) created this set of requirements
actor		0..*	canonical(ActorDefinition)	Actor for these requirements
statement		0..*	BackboneElement	Actual statement as markdown
key		1..1	id	Key that identifies this statement
label	T	0..1	string	Short Human label for this statement
conformance		0..*	code	SHALL \| SHOULD \| MAY \| SHOULD-NOT Binding: Conformance Expectation (Required)
conditionality		0..1	boolean	Set to true if requirements statement is conditional
requirement	T	1..1	markdown	The actual requirement
derivedFrom		0..1	string	Another statement this clarifies/restricts ([url#]key)
parent		0..1	string	A larger requirement that this requirement helps to refine and enable
satisfiedBy		0..*	url	Design artifact that satisfies this requirement
reference		0..*	url	External artifact (rule/document etc. that) created this requirement
source		0..*	Reference(CareTeam \| Device \| Group \| HealthcareService \| Organization \| Patient \| Practitioner \| PractitionerRole \| RelatedPerson)	Who asked for this statement
Documentation for this format

See the Extensions for this resource

UML Diagram (Legend)

XML Template

<Requirements xmlns="http://hl7.org/fhir"> 
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <url value="[uri]"/><!-- 0..1 Canonical identifier for this Requirements, represented as a URI (globally unique) -->
 <identifier><!-- 0..* Identifier Additional identifier for the Requirements (business identifier) --></identifier>
 <version value="[string]"/><!-- 0..1 Business version of the Requirements -->
 <versionAlgorithm[x]><!-- 0..1 string|Coding How to compare versions --></versionAlgorithm[x]>
 <name value="[string]"/><!-- I 0..1 Name for this Requirements (computer friendly) -->
 <title value="[string]"/><!-- 0..1 Name for this Requirements (human friendly) -->
 <status value="[code]"/><!-- 1..1 draft | active | retired | unknown -->
 <experimental value="[boolean]"/><!-- 0..1 For testing purposes, not real usage -->
 <date value="[dateTime]"/><!-- 0..1 Date last changed -->
 <publisher value="[string]"/><!-- 0..1 Name of the publisher/steward (organization or individual) -->
 <contact><!-- 0..* ContactDetail Contact details for the publisher --></contact>
 <description value="[markdown]"/><!-- 0..1 Natural language description of the requirements -->
 <useContext><!-- 0..* UsageContext The context that the content is intended to support --></useContext>
 <jurisdiction><!-- 0..* CodeableConcept Intended jurisdiction for Requirements (if applicable) --></jurisdiction>
 <purpose value="[markdown]"/><!-- 0..1 Why this Requirements is defined -->
 <copyright value="[markdown]"/><!-- 0..1 Use and/or publishing restrictions -->
 <copyrightLabel value="[string]"/><!-- 0..1 Copyright holder and year(s) -->
 <derivedFrom><!-- 0..* canonical(Requirements) Other set of Requirements this builds on --></derivedFrom>
 <reference value="[url]"/><!-- 0..* External artifact (rule/document etc. that) created this set of requirements -->
 <actor><!-- 0..* canonical(ActorDefinition) Actor for these requirements --></actor>
 <statement>  <!-- 0..* Actual statement as markdown -->
  <key value="[id]"/><!-- 1..1 Key that identifies this statement -->
  <label value="[string]"/><!-- 0..1 Short Human label for this statement -->
  <conformance value="[code]"/><!-- 0..* SHALL | SHOULD | MAY | SHOULD-NOT -->
  <conditionality value="[boolean]"/><!-- 0..1 Set to true if requirements statement is conditional -->
  <requirement value="[markdown]"/><!-- 1..1 The actual requirement -->
  <derivedFrom value="[string]"/><!-- 0..1 Another statement this clarifies/restricts ([url#]key) -->
  <parent value="[string]"/><!-- 0..1 A larger requirement that this requirement helps to refine and enable -->
  <satisfiedBy value="[url]"/><!-- 0..* Design artifact that satisfies this requirement -->
  <reference value="[url]"/><!-- 0..* External artifact (rule/document etc. that) created this requirement -->
  <source><!-- 0..* Reference(CareTeam|Device|Group|HealthcareService|
    Organization|Patient|Practitioner|PractitionerRole|RelatedPerson) Who asked for this statement --></source>
 </statement>
</Requirements>

JSON Template

{
  "resourceType" : "Requirements",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "url" : "<uri>", // Canonical identifier for this Requirements, represented as a URI (globally unique)
  "identifier" : [{ Identifier }], // Additional identifier for the Requirements (business identifier)
  "version" : "<string>", // Business version of the Requirements
  // versionAlgorithm[x]: How to compare versions. One of these 2:
  "versionAlgorithmString" : "<string>",
  "versionAlgorithmCoding" : { Coding },
  "name" : "<string>", // I Name for this Requirements (computer friendly)
  "title" : "<string>", // Name for this Requirements (human friendly)
  "status" : "<code>", // R!  draft | active | retired | unknown
  "experimental" : <boolean>, // For testing purposes, not real usage
  "date" : "<dateTime>", // Date last changed
  "publisher" : "<string>", // Name of the publisher/steward (organization or individual)
  "contact" : [{ ContactDetail }], // Contact details for the publisher
  "description" : "<markdown>", // Natural language description of the requirements
  "useContext" : [{ UsageContext }], // The context that the content is intended to support
  "jurisdiction" : [{ CodeableConcept }], // Intended jurisdiction for Requirements (if applicable)
  "purpose" : "<markdown>", // Why this Requirements is defined
  "copyright" : "<markdown>", // Use and/or publishing restrictions
  "copyrightLabel" : "<string>", // Copyright holder and year(s)
  "derivedFrom" : ["<canonical(Requirements)>"], // Other set of Requirements this builds on
  "reference" : ["<url>"], // External artifact (rule/document etc. that) created this set of requirements
  "actor" : ["<canonical(ActorDefinition)>"], // Actor for these requirements
  "statement" : [{ // Actual statement as markdown
    "key" : "<id>", // R!  Key that identifies this statement
    "label" : "<string>", // Short Human label for this statement
    "conformance" : ["<code>"], // SHALL | SHOULD | MAY | SHOULD-NOT
    "conditionality" : <boolean>, // Set to true if requirements statement is conditional
    "requirement" : "<markdown>", // R!  The actual requirement
    "derivedFrom" : "<string>", // Another statement this clarifies/restricts ([url#]key)
    "parent" : "<string>", // A larger requirement that this requirement helps to refine and enable
    "satisfiedBy" : ["<url>"], // Design artifact that satisfies this requirement
    "reference" : ["<url>"], // External artifact (rule/document etc. that) created this requirement
    "source" : [{ Reference(CareTeam|Device|Group|HealthcareService|
    Organization|Patient|Practitioner|PractitionerRole|RelatedPerson) }] // Who asked for this statement
  }]
}

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .


[ a fhir:Requirements;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:url [ uri ] ; # 0..1 Canonical identifier for this Requirements, represented as a URI (globally unique)
  fhir:identifier  ( [ Identifier ] ... ) ; # 0..* Additional identifier for the Requirements (business identifier)
  fhir:version [ string ] ; # 0..1 Business version of the Requirements
  # versionAlgorithm[x] : 0..1 How to compare versions. One of these 2
    fhir:versionAlgorithm [  a fhir:string ; string ]
    fhir:versionAlgorithm [  a fhir:Coding ; Coding ]
  fhir:name [ string ] ; # 0..1 I Name for this Requirements (computer friendly)
  fhir:title [ string ] ; # 0..1 Name for this Requirements (human friendly)
  fhir:status [ code ] ; # 1..1 draft | active | retired | unknown
  fhir:experimental [ boolean ] ; # 0..1 For testing purposes, not real usage
  fhir:date [ dateTime ] ; # 0..1 Date last changed
  fhir:publisher [ string ] ; # 0..1 Name of the publisher/steward (organization or individual)
  fhir:contact  ( [ ContactDetail ] ... ) ; # 0..* Contact details for the publisher
  fhir:description [ markdown ] ; # 0..1 Natural language description of the requirements
  fhir:useContext  ( [ UsageContext ] ... ) ; # 0..* The context that the content is intended to support
  fhir:jurisdiction  ( [ CodeableConcept ] ... ) ; # 0..* Intended jurisdiction for Requirements (if applicable)
  fhir:purpose [ markdown ] ; # 0..1 Why this Requirements is defined
  fhir:copyright [ markdown ] ; # 0..1 Use and/or publishing restrictions
  fhir:copyrightLabel [ string ] ; # 0..1 Copyright holder and year(s)
  fhir:derivedFrom  ( [ canonical(Requirements) ] ... ) ; # 0..* Other set of Requirements this builds on
  fhir:reference  ( [ url ] ... ) ; # 0..* External artifact (rule/document etc. that) created this set of requirements
  fhir:actor  ( [ canonical(ActorDefinition) ] ... ) ; # 0..* Actor for these requirements
  fhir:statement ( [ # 0..* Actual statement as markdown
    fhir:key [ id ] ; # 1..1 Key that identifies this statement
    fhir:label [ string ] ; # 0..1 Short Human label for this statement
    fhir:conformance  ( [ code ] ... ) ; # 0..* SHALL | SHOULD | MAY | SHOULD-NOT
    fhir:conditionality [ boolean ] ; # 0..1 Set to true if requirements statement is conditional
    fhir:requirement [ markdown ] ; # 1..1 The actual requirement
    fhir:derivedFrom [ string ] ; # 0..1 Another statement this clarifies/restricts ([url#]key)
    fhir:parent [ string ] ; # 0..1 A larger requirement that this requirement helps to refine and enable
    fhir:satisfiedBy  ( [ url ] ... ) ; # 0..* Design artifact that satisfies this requirement
    fhir:reference  ( [ url ] ... ) ; # 0..* External artifact (rule/document etc. that) created this requirement
    fhir:source  ( [ Reference(CareTeam|Device|Group|HealthcareService|Organization|Patient|Practitioner|
  PractitionerRole|RelatedPerson) ] ... ) ; # 0..* Who asked for this statement
  ] ... ) ;
]

Changes from both R4 and R4B

This resource did not exist in Release R4

See the Full Difference for further information

This analysis is available for R4 as XML or JSON and for R4B as XML or JSON.

Structure

Name	Flags	Card.	Type	Description & Constraints
Requirements	TU		DomainResource	A set of requirements - features of systems that are necessary + Warning: Name should be usable as an identifier for the module by machine processing applications such as code generation Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension Interfaces Implemented: CanonicalResource
url	Σ C	0..1	uri	Canonical identifier for this Requirements, represented as a URI (globally unique) + Warning: URL should not contain \| or # - these characters make processing canonical references problematic
identifier	Σ	0..*	Identifier	Additional identifier for the Requirements (business identifier)
version	Σ	0..1	string	Business version of the Requirements
versionAlgorithm[x]	Σ	0..1		How to compare versions Binding: Version Algorithm (Extensible)
versionAlgorithmString			string
versionAlgorithmCoding			Coding
name	Σ C	0..1	string	Name for this Requirements (computer friendly)
title	Σ T	0..1	string	Name for this Requirements (human friendly)
status	?!Σ	1..1	code	draft \| active \| retired \| unknown Binding: PublicationStatus (Required)
experimental	Σ	0..1	boolean	For testing purposes, not real usage
date	Σ	0..1	dateTime	Date last changed
publisher	Σ T	0..1	string	Name of the publisher/steward (organization or individual)
contact	Σ	0..*	ContactDetail	Contact details for the publisher
description	T	0..1	markdown	Natural language description of the requirements
useContext	Σ TU	0..*	UsageContext	The context that the content is intended to support
jurisdiction	Σ XD	0..*	CodeableConcept	Intended jurisdiction for Requirements (if applicable) Binding: Jurisdiction ValueSet (Extensible)
purpose	T	0..1	markdown	Why this Requirements is defined
copyright	T	0..1	markdown	Use and/or publishing restrictions
copyrightLabel	T	0..1	string	Copyright holder and year(s)
derivedFrom	Σ	0..*	canonical(Requirements)	Other set of Requirements this builds on
reference		0..*	url	External artifact (rule/document etc. that) created this set of requirements
actor		0..*	canonical(ActorDefinition)	Actor for these requirements
statement		0..*	BackboneElement	Actual statement as markdown
key		1..1	id	Key that identifies this statement
label	T	0..1	string	Short Human label for this statement
conformance		0..*	code	SHALL \| SHOULD \| MAY \| SHOULD-NOT Binding: Conformance Expectation (Required)
conditionality		0..1	boolean	Set to true if requirements statement is conditional
requirement	T	1..1	markdown	The actual requirement
derivedFrom		0..1	string	Another statement this clarifies/restricts ([url#]key)
parent		0..1	string	A larger requirement that this requirement helps to refine and enable
satisfiedBy		0..*	url	Design artifact that satisfies this requirement
reference		0..*	url	External artifact (rule/document etc. that) created this requirement
source		0..*	Reference(CareTeam \| Device \| Group \| HealthcareService \| Organization \| Patient \| Practitioner \| PractitionerRole \| RelatedPerson)	Who asked for this statement
Documentation for this format

See the Extensions for this resource

UML Diagram (Legend)

XML Template

<Requirements xmlns="http://hl7.org/fhir"> 
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <url value="[uri]"/><!-- 0..1 Canonical identifier for this Requirements, represented as a URI (globally unique) -->
 <identifier><!-- 0..* Identifier Additional identifier for the Requirements (business identifier) --></identifier>
 <version value="[string]"/><!-- 0..1 Business version of the Requirements -->
 <versionAlgorithm[x]><!-- 0..1 string|Coding How to compare versions --></versionAlgorithm[x]>
 <name value="[string]"/><!-- I 0..1 Name for this Requirements (computer friendly) -->
 <title value="[string]"/><!-- 0..1 Name for this Requirements (human friendly) -->
 <status value="[code]"/><!-- 1..1 draft | active | retired | unknown -->
 <experimental value="[boolean]"/><!-- 0..1 For testing purposes, not real usage -->
 <date value="[dateTime]"/><!-- 0..1 Date last changed -->
 <publisher value="[string]"/><!-- 0..1 Name of the publisher/steward (organization or individual) -->
 <contact><!-- 0..* ContactDetail Contact details for the publisher --></contact>
 <description value="[markdown]"/><!-- 0..1 Natural language description of the requirements -->
 <useContext><!-- 0..* UsageContext The context that the content is intended to support --></useContext>
 <jurisdiction><!-- 0..* CodeableConcept Intended jurisdiction for Requirements (if applicable) --></jurisdiction>
 <purpose value="[markdown]"/><!-- 0..1 Why this Requirements is defined -->
 <copyright value="[markdown]"/><!-- 0..1 Use and/or publishing restrictions -->
 <copyrightLabel value="[string]"/><!-- 0..1 Copyright holder and year(s) -->
 <derivedFrom><!-- 0..* canonical(Requirements) Other set of Requirements this builds on --></derivedFrom>
 <reference value="[url]"/><!-- 0..* External artifact (rule/document etc. that) created this set of requirements -->
 <actor><!-- 0..* canonical(ActorDefinition) Actor for these requirements --></actor>
 <statement>  <!-- 0..* Actual statement as markdown -->
  <key value="[id]"/><!-- 1..1 Key that identifies this statement -->
  <label value="[string]"/><!-- 0..1 Short Human label for this statement -->
  <conformance value="[code]"/><!-- 0..* SHALL | SHOULD | MAY | SHOULD-NOT -->
  <conditionality value="[boolean]"/><!-- 0..1 Set to true if requirements statement is conditional -->
  <requirement value="[markdown]"/><!-- 1..1 The actual requirement -->
  <derivedFrom value="[string]"/><!-- 0..1 Another statement this clarifies/restricts ([url#]key) -->
  <parent value="[string]"/><!-- 0..1 A larger requirement that this requirement helps to refine and enable -->
  <satisfiedBy value="[url]"/><!-- 0..* Design artifact that satisfies this requirement -->
  <reference value="[url]"/><!-- 0..* External artifact (rule/document etc. that) created this requirement -->
  <source><!-- 0..* Reference(CareTeam|Device|Group|HealthcareService|
    Organization|Patient|Practitioner|PractitionerRole|RelatedPerson) Who asked for this statement --></source>
 </statement>
</Requirements>

JSON Template

{
  "resourceType" : "Requirements",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "url" : "<uri>", // Canonical identifier for this Requirements, represented as a URI (globally unique)
  "identifier" : [{ Identifier }], // Additional identifier for the Requirements (business identifier)
  "version" : "<string>", // Business version of the Requirements
  // versionAlgorithm[x]: How to compare versions. One of these 2:
  "versionAlgorithmString" : "<string>",
  "versionAlgorithmCoding" : { Coding },
  "name" : "<string>", // I Name for this Requirements (computer friendly)
  "title" : "<string>", // Name for this Requirements (human friendly)
  "status" : "<code>", // R!  draft | active | retired | unknown
  "experimental" : <boolean>, // For testing purposes, not real usage
  "date" : "<dateTime>", // Date last changed
  "publisher" : "<string>", // Name of the publisher/steward (organization or individual)
  "contact" : [{ ContactDetail }], // Contact details for the publisher
  "description" : "<markdown>", // Natural language description of the requirements
  "useContext" : [{ UsageContext }], // The context that the content is intended to support
  "jurisdiction" : [{ CodeableConcept }], // Intended jurisdiction for Requirements (if applicable)
  "purpose" : "<markdown>", // Why this Requirements is defined
  "copyright" : "<markdown>", // Use and/or publishing restrictions
  "copyrightLabel" : "<string>", // Copyright holder and year(s)
  "derivedFrom" : ["<canonical(Requirements)>"], // Other set of Requirements this builds on
  "reference" : ["<url>"], // External artifact (rule/document etc. that) created this set of requirements
  "actor" : ["<canonical(ActorDefinition)>"], // Actor for these requirements
  "statement" : [{ // Actual statement as markdown
    "key" : "<id>", // R!  Key that identifies this statement
    "label" : "<string>", // Short Human label for this statement
    "conformance" : ["<code>"], // SHALL | SHOULD | MAY | SHOULD-NOT
    "conditionality" : <boolean>, // Set to true if requirements statement is conditional
    "requirement" : "<markdown>", // R!  The actual requirement
    "derivedFrom" : "<string>", // Another statement this clarifies/restricts ([url#]key)
    "parent" : "<string>", // A larger requirement that this requirement helps to refine and enable
    "satisfiedBy" : ["<url>"], // Design artifact that satisfies this requirement
    "reference" : ["<url>"], // External artifact (rule/document etc. that) created this requirement
    "source" : [{ Reference(CareTeam|Device|Group|HealthcareService|
    Organization|Patient|Practitioner|PractitionerRole|RelatedPerson) }] // Who asked for this statement
  }]
}

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .


[ a fhir:Requirements;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:url [ uri ] ; # 0..1 Canonical identifier for this Requirements, represented as a URI (globally unique)
  fhir:identifier  ( [ Identifier ] ... ) ; # 0..* Additional identifier for the Requirements (business identifier)
  fhir:version [ string ] ; # 0..1 Business version of the Requirements
  # versionAlgorithm[x] : 0..1 How to compare versions. One of these 2
    fhir:versionAlgorithm [  a fhir:string ; string ]
    fhir:versionAlgorithm [  a fhir:Coding ; Coding ]
  fhir:name [ string ] ; # 0..1 I Name for this Requirements (computer friendly)
  fhir:title [ string ] ; # 0..1 Name for this Requirements (human friendly)
  fhir:status [ code ] ; # 1..1 draft | active | retired | unknown
  fhir:experimental [ boolean ] ; # 0..1 For testing purposes, not real usage
  fhir:date [ dateTime ] ; # 0..1 Date last changed
  fhir:publisher [ string ] ; # 0..1 Name of the publisher/steward (organization or individual)
  fhir:contact  ( [ ContactDetail ] ... ) ; # 0..* Contact details for the publisher
  fhir:description [ markdown ] ; # 0..1 Natural language description of the requirements
  fhir:useContext  ( [ UsageContext ] ... ) ; # 0..* The context that the content is intended to support
  fhir:jurisdiction  ( [ CodeableConcept ] ... ) ; # 0..* Intended jurisdiction for Requirements (if applicable)
  fhir:purpose [ markdown ] ; # 0..1 Why this Requirements is defined
  fhir:copyright [ markdown ] ; # 0..1 Use and/or publishing restrictions
  fhir:copyrightLabel [ string ] ; # 0..1 Copyright holder and year(s)
  fhir:derivedFrom  ( [ canonical(Requirements) ] ... ) ; # 0..* Other set of Requirements this builds on
  fhir:reference  ( [ url ] ... ) ; # 0..* External artifact (rule/document etc. that) created this set of requirements
  fhir:actor  ( [ canonical(ActorDefinition) ] ... ) ; # 0..* Actor for these requirements
  fhir:statement ( [ # 0..* Actual statement as markdown
    fhir:key [ id ] ; # 1..1 Key that identifies this statement
    fhir:label [ string ] ; # 0..1 Short Human label for this statement
    fhir:conformance  ( [ code ] ... ) ; # 0..* SHALL | SHOULD | MAY | SHOULD-NOT
    fhir:conditionality [ boolean ] ; # 0..1 Set to true if requirements statement is conditional
    fhir:requirement [ markdown ] ; # 1..1 The actual requirement
    fhir:derivedFrom [ string ] ; # 0..1 Another statement this clarifies/restricts ([url#]key)
    fhir:parent [ string ] ; # 0..1 A larger requirement that this requirement helps to refine and enable
    fhir:satisfiedBy  ( [ url ] ... ) ; # 0..* Design artifact that satisfies this requirement
    fhir:reference  ( [ url ] ... ) ; # 0..* External artifact (rule/document etc. that) created this requirement
    fhir:source  ( [ Reference(CareTeam|Device|Group|HealthcareService|Organization|Patient|Practitioner|
  PractitionerRole|RelatedPerson) ] ... ) ; # 0..* Who asked for this statement
  ] ... ) ;
]

Changes from both R4 and R4B

This resource did not exist in Release R4

See the Full Difference for further information

This analysis is available for R4 as XML or JSON and for R4B as XML or JSON.

Additional definitions: Master Definition XML + JSON, XML Schema/Schematron + JSON Schema, ShEx (for Turtle) , the spreadsheet version & the dependency analysis

5.12.5.1 Terminology Bindings

Path	ValueSet	Type	Documentation
Requirements.versionAlgorithm[x]	VersionAlgorithm	Extensible	Indicates the mechanism used to compare versions to determine which is more current.
Requirements.status	PublicationStatus	Required	The lifecycle status of an artifact.
Requirements.jurisdiction	JurisdictionValueSet	Extensible	This value set defines a base set of codes for country, country subdivision and region for indicating where a resource is intended to be used. Note: The codes for countries and country subdivisions are taken from ISO 3166 while the codes for "supra-national" regions are from UN Standard country or area codes for statistical use (M49) .
Requirements.statement.conformance	ConformanceExpectation	Required	Description Needed Here

Path

ValueSet

Type

Documentation

Requirements.versionAlgorithm[x]

VersionAlgorithm

Extensible

Indicates the mechanism used to compare versions to determine which is more current.

Requirements.status

PublicationStatus

Required

The lifecycle status of an artifact.

Requirements.jurisdiction

JurisdictionValueSet

Extensible

This value set defines a base set of codes for country, country subdivision and region for indicating where a resource is intended to be used.

Note: The codes for countries and country subdivisions are taken from ISO 3166 icon while the codes for "supra-national" regions are from UN Standard country or area codes for statistical use (M49) icon .

Requirements.statement.conformance

ConformanceExpectation

Required

Description Needed Here

5.12.5.2 Constraints

UniqueKey

Level

Location

Description

Expression

cnl-0

Warning

(base)

Name should be usable as an identifier for the module by machine processing applications such as code generation

name.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$')

cnl-1

Warning

Requirements.url

URL should not contain | or # - these characters make processing canonical references problematic

exists() implies matches('^[^|# ]+$')

5.12.6 Search Parameters

Search parameters for this resource. See also the full list of search parameters for this resource, and check the Extensions registry for search parameters on extensions related to this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.

Name	Type	Description	Expression	In Common
actor	reference	An actor these requirements are for	Requirements.actor (ActorDefinition)
context	token	A use context assigned to the requirements	(Requirements.useContext.value.ofType(CodeableConcept))	30 Resources
context-quantity	quantity	A quantity- or range-valued use context assigned to the requirements	(Requirements.useContext.value.ofType(Quantity)) \| (Requirements.useContext.value.ofType(Range))	30 Resources
context-type	token	A type of use context assigned to the requirements	Requirements.useContext.code	30 Resources
context-type-quantity	composite	A use context type and quantity- or range-based value assigned to the requirements	On Requirements.useContext: context-type: code context-quantity: value.ofType(Quantity) \| value.ofType(Range)	30 Resources
context-type-value	composite	A use context type and value assigned to the requirements	On Requirements.useContext: context-type: code context: value.ofType(CodeableConcept)	30 Resources
date	date	The requirements publication date	Requirements.date	30 Resources
derived-from	reference	The requirements these are derived from	Requirements.derivedFrom (Requirements)
description	string	The description of the requirements	Requirements.description	28 Resources
identifier	token	External identifier for the requirements	Requirements.identifier	35 Resources
jurisdiction	token	Intended jurisdiction for the requirements	Requirements.jurisdiction	26 Resources
name	string	Computationally friendly name of the requirements	Requirements.name	27 Resources
publisher	string	Name of the publisher of the requirements	Requirements.publisher	30 Resources
status	token	The current status of the requirements	Requirements.status	36 Resources
title	string	The human-friendly name of the requirements	Requirements.title	27 Resources
url	uri	The uri that identifies the requirements	Requirements.url	35 Resources
version	token	The business version of the requirements	Requirements.version	30 Resources