Extensions for Using Data Elements from FHIR R5 in FHIR R4
0.1.0 - STU International flag

Extensions for Using Data Elements from FHIR R5 in FHIR R4 - Downloaded Version null See the Directory of published versions

Extension: ExtensionRequirements_Statement - Detailed Descriptions

Page standards status: Trial-use Maturity Level: 0

Definitions for the ext-R5-Requirements.statement extension.

Guidance on how to interpret the contents of this table can be foundhere

0. Extension
Definition

R5: Requirements.statement (new:BackboneElement)


Optional Extension Element - found in all resources.

ShortR5: Actual statement as markdown (new)Optional Extensions Element
Comments

Element Requirements.statement is not mapped to FHIR R4, since FHIR R5 Requirements is not mapped. Element Requirements.statement has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

Control0..*
This element is affected by the following invariants: ele-1
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
2. Extension.extension
Definition

An Extension


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.

ShortExtensionAdditional content defined by implementations
Comments

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.

Control20..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ url
  • 4. Extension.extension:key
    Slice Namekey
    Definition

    R5: Requirements.statement.key (new:id)

    ShortR5: Key that identifies this statement (new)Additional content defined by implementations
    Comments

    Element Requirements.statement.key is part of an existing definition because parent element Requirements.statement requires a cross-version extension. Element Requirements.statement.key is not mapped to FHIR R4, since FHIR R5 Requirements is not mapped. Element Requirements.statement.key has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). Refer directly to the statement by {url}#{key}

    Control10..1*
    TypeExtension
    Is Modifierfalse
    Summaryfalse
    Requirements

    Element Requirements.statement.key is part of an existing definition because parent element Requirements.statement requires a cross-version extension. Element Requirements.statement.key is not mapped to FHIR R4, since FHIR R5 Requirements is not mapped. Element Requirements.statement.key has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    6. Extension.extension:key.url
    Definition

    Source of the definition for the extension code - a logical name or a URL.

    Shortidentifies the meaning of the extension
    Comments

    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.

    Control1..1
    Typeuri
    Is Modifierfalse
    XML FormatIn the XML format, this property is represented as an attribute.
    Summaryfalse
    Fixed Valuekey
    8. Extension.extension:key.value[x]
    Definition

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


    Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

    ShortKey that identifies this statementValue of extension
    Comments

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

    Control10..1
    Typeid, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    10. Extension.extension:label
    Slice Namelabel
    Definition

    R5: Requirements.statement.label (new:string)

    ShortR5: Short Human label for this statement (new)Additional content defined by implementations
    Comments

    Element Requirements.statement.label is part of an existing definition because parent element Requirements.statement requires a cross-version extension. Element Requirements.statement.label is not mapped to FHIR R4, since FHIR R5 Requirements is not mapped. Element Requirements.statement.label has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). 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)

    Control0..1*
    TypeExtension
    Is Modifierfalse
    Summaryfalse
    Requirements

    Element Requirements.statement.label is part of an existing definition because parent element Requirements.statement requires a cross-version extension. Element Requirements.statement.label is not mapped to FHIR R4, since FHIR R5 Requirements is not mapped. Element Requirements.statement.label has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    12. Extension.extension:label.url
    Definition

    Source of the definition for the extension code - a logical name or a URL.

    Shortidentifies the meaning of the extension
    Comments

    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.

    Control1..1
    Typeuri
    Is Modifierfalse
    XML FormatIn the XML format, this property is represented as an attribute.
    Summaryfalse
    Fixed Valuelabel
    14. Extension.extension:label.value[x]
    Definition

    A short human usable label for this statement.


    Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

    ShortShort Human label for this statementValue of extension
    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)

    Control0..1
    Typestring, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    16. Extension.extension:conformance
    Slice Nameconformance
    Definition

    R5: Requirements.statement.conformance (new:code)

    ShortR5: SHALL | SHOULD | MAY | SHOULD-NOT (new)Additional content defined by implementations
    Comments

    Element Requirements.statement.conformance is part of an existing definition because parent element Requirements.statement requires a cross-version extension. Element Requirements.statement.conformance is not mapped to FHIR R4, since FHIR R5 Requirements is not mapped. Element Requirements.statement.conformance has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). 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)

    Control0..*
    TypeExtension
    Is Modifierfalse
    Summaryfalse
    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. Element Requirements.statement.conformance is part of an existing definition because parent element Requirements.statement requires a cross-version extension. Element Requirements.statement.conformance is not mapped to FHIR R4, since FHIR R5 Requirements is not mapped. Element Requirements.statement.conformance has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    18. Extension.extension:conformance.url
    Definition

    Source of the definition for the extension code - a logical name or a URL.

    Shortidentifies the meaning of the extension
    Comments

    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.

    Control1..1
    Typeuri
    Is Modifierfalse
    XML FormatIn the XML format, this property is represented as an attribute.
    Summaryfalse
    Fixed Valueconformance
    20. Extension.extension:conformance.value[x]
    Definition

    A short human usable label for this statement.


    Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

    ShortSHALL | SHOULD | MAY | SHOULD-NOTValue of extension
    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)

    Control0..1
    BindingThe codes SHALL be taken from For codes, see R5ConformanceExpectationForR4 (0.1.0)
    (required to http://hl7.org/fhir/uv/xver/ValueSet/R5-conformance-expectation-for-R4|0.1.0)
    Typecode, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    22. Extension.extension:conditionality
    Slice Nameconditionality
    Definition

    R5: Requirements.statement.conditionality (new:boolean)

    ShortR5: Set to true if requirements statement is conditional (new)Additional content defined by implementations
    Comments

    Element Requirements.statement.conditionality is part of an existing definition because parent element Requirements.statement requires a cross-version extension. Element Requirements.statement.conditionality is not mapped to FHIR R4, since FHIR R5 Requirements is not mapped. Element Requirements.statement.conditionality has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). There is no intent that the conditional statement by evaluatable

    Control0..1*
    TypeExtension
    Is Modifierfalse
    Summaryfalse
    Requirements

    Element Requirements.statement.conditionality is part of an existing definition because parent element Requirements.statement requires a cross-version extension. Element Requirements.statement.conditionality is not mapped to FHIR R4, since FHIR R5 Requirements is not mapped. Element Requirements.statement.conditionality has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    24. Extension.extension:conditionality.url
    Definition

    Source of the definition for the extension code - a logical name or a URL.

    Shortidentifies the meaning of the extension
    Comments

    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.

    Control1..1
    Typeuri
    Is Modifierfalse
    XML FormatIn the XML format, this property is represented as an attribute.
    Summaryfalse
    Fixed Valueconditionality
    26. Extension.extension:conditionality.value[x]
    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.


    Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

    ShortSet to true if requirements statement is conditionalValue of extension
    Comments

    There is no intent that the conditional statement by evaluatable

    Control0..1
    Typeboolean, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, Expression, Signature, unsignedInt, time
    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    28. Extension.extension:requirement
    Slice Namerequirement
    Definition

    R5: Requirements.statement.requirement (new:markdown)

    ShortR5: The actual requirement (new)Additional content defined by implementations
    Comments

    Element Requirements.statement.requirement is part of an existing definition because parent element Requirements.statement requires a cross-version extension. Element Requirements.statement.requirement is not mapped to FHIR R4, since FHIR R5 Requirements is not mapped. Element Requirements.statement.requirement has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

    Control10..1*
    TypeExtension
    Is Modifierfalse
    Summaryfalse
    Requirements

    Element Requirements.statement.requirement is part of an existing definition because parent element Requirements.statement requires a cross-version extension. Element Requirements.statement.requirement is not mapped to FHIR R4, since FHIR R5 Requirements is not mapped. Element Requirements.statement.requirement has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    30. Extension.extension:requirement.url
    Definition

    Source of the definition for the extension code - a logical name or a URL.

    Shortidentifies the meaning of the extension
    Comments

    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.

    Control1..1
    Typeuri
    Is Modifierfalse
    XML FormatIn the XML format, this property is represented as an attribute.
    Summaryfalse
    Fixed Valuerequirement
    32. Extension.extension:requirement.value[x]
    Definition

    The actual requirement for human consumption.


    Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

    ShortThe actual requirementValue of extension
    Control10..1
    Typemarkdown, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    34. Extension.extension:derivedFrom
    Slice NamederivedFrom
    Definition

    R5: Requirements.statement.derivedFrom (new:string)

    ShortR5: Another statement this clarifies/restricts ([url#]key) (new)Additional content defined by implementations
    Comments

    Element Requirements.statement.derivedFrom is part of an existing definition because parent element Requirements.statement requires a cross-version extension. Element Requirements.statement.derivedFrom is not mapped to FHIR R4, since FHIR R5 Requirements is not mapped. Element Requirements.statement.derivedFrom has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). 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

    Control0..1*
    TypeExtension
    Is Modifierfalse
    Summaryfalse
    Requirements

    Element Requirements.statement.derivedFrom is part of an existing definition because parent element Requirements.statement requires a cross-version extension. Element Requirements.statement.derivedFrom is not mapped to FHIR R4, since FHIR R5 Requirements is not mapped. Element Requirements.statement.derivedFrom has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    36. Extension.extension:derivedFrom.url
    Definition

    Source of the definition for the extension code - a logical name or a URL.

    Shortidentifies the meaning of the extension
    Comments

    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.

    Control1..1
    Typeuri
    Is Modifierfalse
    XML FormatIn the XML format, this property is represented as an attribute.
    Summaryfalse
    Fixed ValuederivedFrom
    38. Extension.extension:derivedFrom.value[x]
    Definition

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


    Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

    ShortAnother statement this clarifies/restricts ([url#]key)Value of extension
    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

    Control0..1
    Typestring, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    40. Extension.extension:parent
    Slice Nameparent
    Definition

    R5: Requirements.statement.parent (new:string)

    ShortR5: A larger requirement that this requirement helps to refine and enable (new)Additional content defined by implementations
    Comments

    Element Requirements.statement.parent is part of an existing definition because parent element Requirements.statement requires a cross-version extension. Element Requirements.statement.parent is not mapped to FHIR R4, since FHIR R5 Requirements is not mapped. Element Requirements.statement.parent has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). 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.

    Control0..1*
    TypeExtension
    Is Modifierfalse
    Summaryfalse
    Requirements

    Allows requirements to be organized compositionally. E.g. Epic/Story/Task. Element Requirements.statement.parent is part of an existing definition because parent element Requirements.statement requires a cross-version extension. Element Requirements.statement.parent is not mapped to FHIR R4, since FHIR R5 Requirements is not mapped. Element Requirements.statement.parent has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    42. Extension.extension:parent.url
    Definition

    Source of the definition for the extension code - a logical name or a URL.

    Shortidentifies the meaning of the extension
    Comments

    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.

    Control1..1
    Typeuri
    Is Modifierfalse
    XML FormatIn the XML format, this property is represented as an attribute.
    Summaryfalse
    Fixed Valueparent
    44. Extension.extension:parent.value[x]
    Definition

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


    Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

    ShortA larger requirement that this requirement helps to refine and enableValue of extension
    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.

    Control0..1
    Typestring, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    46. Extension.extension:satisfiedBy
    Slice NamesatisfiedBy
    Definition

    R5: Requirements.statement.satisfiedBy (new:url)

    ShortR5: Design artifact that satisfies this requirement (new)Additional content defined by implementations
    Comments

    Element Requirements.statement.satisfiedBy is part of an existing definition because parent element Requirements.statement requires a cross-version extension. Element Requirements.statement.satisfiedBy is not mapped to FHIR R4, since FHIR R5 Requirements is not mapped. Element Requirements.statement.satisfiedBy has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). 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.

    Control0..*
    TypeExtension
    Is Modifierfalse
    Summaryfalse
    Requirements

    Element Requirements.statement.satisfiedBy is part of an existing definition because parent element Requirements.statement requires a cross-version extension. Element Requirements.statement.satisfiedBy is not mapped to FHIR R4, since FHIR R5 Requirements is not mapped. Element Requirements.statement.satisfiedBy has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    48. Extension.extension:satisfiedBy.url
    Definition

    Source of the definition for the extension code - a logical name or a URL.

    Shortidentifies the meaning of the extension
    Comments

    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.

    Control1..1
    Typeuri
    Is Modifierfalse
    XML FormatIn the XML format, this property is represented as an attribute.
    Summaryfalse
    Fixed ValuesatisfiedBy
    50. Extension.extension:satisfiedBy.value[x]
    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.


    Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

    ShortDesign artifact that satisfies this requirementValue of extension
    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.

    Control0..1
    Typeurl, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    52. Extension.extension:reference
    Slice Namereference
    Definition

    R5: Requirements.statement.reference (new:url)

    ShortR5: External artifact (rule/document etc. that) created this requirement (new)Additional content defined by implementations
    Comments

    Element Requirements.statement.reference is part of an existing definition because parent element Requirements.statement requires a cross-version extension. Element Requirements.statement.reference is not mapped to FHIR R4, since FHIR R5 Requirements is not mapped. Element Requirements.statement.reference has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

    Control0..*
    TypeExtension
    Is Modifierfalse
    Summaryfalse
    Requirements

    Element Requirements.statement.reference is part of an existing definition because parent element Requirements.statement requires a cross-version extension. Element Requirements.statement.reference is not mapped to FHIR R4, since FHIR R5 Requirements is not mapped. Element Requirements.statement.reference has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    54. Extension.extension:reference.url
    Definition

    Source of the definition for the extension code - a logical name or a URL.

    Shortidentifies the meaning of the extension
    Comments

    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.

    Control1..1
    Typeuri
    Is Modifierfalse
    XML FormatIn the XML format, this property is represented as an attribute.
    Summaryfalse
    Fixed Valuereference
    56. Extension.extension:reference.value[x]
    Definition

    A reference to another artifact that created this requirement. This could be a Profile, etc., or external regulation, or business requirements expressed elsewhere.


    Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

    ShortExternal artifact (rule/document etc. that) created this requirementValue of extension
    Control0..1
    Typeurl, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    58. Extension.extension:source
    Slice Namesource
    Definition

    R5: Requirements.statement.source (new:Reference(CareTeam,Device,Group,HealthcareService,Organization,Patient,Practitioner,PractitionerRole,RelatedPerson))

    ShortR5: Who asked for this statement (new)Additional content defined by implementations
    Comments

    Element Requirements.statement.source is part of an existing definition because parent element Requirements.statement requires a cross-version extension. Element Requirements.statement.source is not mapped to FHIR R4, since FHIR R5 Requirements is not mapped. Element Requirements.statement.source has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

    Control0..*
    TypeExtension
    Is Modifierfalse
    Summaryfalse
    Requirements

    Element Requirements.statement.source is part of an existing definition because parent element Requirements.statement requires a cross-version extension. Element Requirements.statement.source is not mapped to FHIR R4, since FHIR R5 Requirements is not mapped. Element Requirements.statement.source has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    60. Extension.extension:source.url
    Definition

    Source of the definition for the extension code - a logical name or a URL.

    Shortidentifies the meaning of the extension
    Comments

    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.

    Control1..1
    Typeuri
    Is Modifierfalse
    XML FormatIn the XML format, this property is represented as an attribute.
    Summaryfalse
    Fixed Valuesource
    62. Extension.extension:source.value[x]
    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.


    Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

    ShortWho asked for this statementValue of extension
    Control0..1
    TypeReference(Cross-version Profile for R5.CareTeam for use in FHIR R4, CareTeam, Cross-version Profile for R5.Device for use in FHIR R4, Device, Cross-version Profile for R5.Group for use in FHIR R4, Group, Cross-version Profile for R5.HealthcareService for use in FHIR R4, HealthcareService, Cross-version Profile for R5.Organization for use in FHIR R4, Organization, Cross-version Profile for R5.Patient for use in FHIR R4, Patient, Cross-version Profile for R5.Practitioner for use in FHIR R4, Practitioner, Cross-version Profile for R5.PractitionerRole for use in FHIR R4, PractitionerRole, Cross-version Profile for R5.RelatedPerson for use in FHIR R4, RelatedPerson), date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
    Is Modifierfalse
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    64. Extension.url
    Definition

    Source of the definition for the extension code - a logical name or a URL.

    Shortidentifies the meaning of the extension
    Comments

    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.

    Control1..1
    Typeuri
    Is Modifierfalse
    XML FormatIn the XML format, this property is represented as an attribute.
    Summaryfalse
    Fixed Valuehttp://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.statement
    66. Extension.value[x]
    Definition

    Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

    ShortValue of extension
    Control0..01
    TypeChoice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

    Guidance on how to interpret the contents of this table can be foundhere

    0. Extension
    Definition

    R5: Requirements.statement (new:BackboneElement)

    ShortR5: Actual statement as markdown (new)
    Comments

    Element Requirements.statement is not mapped to FHIR R4, since FHIR R5 Requirements is not mapped. Element Requirements.statement has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

    Control0..*
    Is Modifierfalse
    2. Extension.extension
    Control2..*
    SlicingThis element introduces a set of slices on Extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • value @ url
    • 4. Extension.extension:key
      Slice Namekey
      Definition

      R5: Requirements.statement.key (new:id)

      ShortR5: Key that identifies this statement (new)
      Comments

      Element Requirements.statement.key is part of an existing definition because parent element Requirements.statement requires a cross-version extension. Element Requirements.statement.key is not mapped to FHIR R4, since FHIR R5 Requirements is not mapped. Element Requirements.statement.key has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). Refer directly to the statement by {url}#{key}

      Control1..1
      Requirements

      Element Requirements.statement.key is part of an existing definition because parent element Requirements.statement requires a cross-version extension. Element Requirements.statement.key is not mapped to FHIR R4, since FHIR R5 Requirements is not mapped. Element Requirements.statement.key has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

      6. Extension.extension:key.url
      Control1..1
      Fixed Valuekey
      8. Extension.extension:key.value[x]
      Definition

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

      ShortKey that identifies this statement
      Comments

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

      Control1..1
      Typeid
      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      10. Extension.extension:label
      Slice Namelabel
      Definition

      R5: Requirements.statement.label (new:string)

      ShortR5: Short Human label for this statement (new)
      Comments

      Element Requirements.statement.label is part of an existing definition because parent element Requirements.statement requires a cross-version extension. Element Requirements.statement.label is not mapped to FHIR R4, since FHIR R5 Requirements is not mapped. Element Requirements.statement.label has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). 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)

      Control0..1
      Requirements

      Element Requirements.statement.label is part of an existing definition because parent element Requirements.statement requires a cross-version extension. Element Requirements.statement.label is not mapped to FHIR R4, since FHIR R5 Requirements is not mapped. Element Requirements.statement.label has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

      12. Extension.extension:label.url
      Control1..1
      Fixed Valuelabel
      14. Extension.extension:label.value[x]
      Definition

      A short human usable label for this statement.

      ShortShort Human label for this statement
      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)

      Control0..1
      Typestring
      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      16. Extension.extension:conformance
      Slice Nameconformance
      Definition

      R5: Requirements.statement.conformance (new:code)

      ShortR5: SHALL | SHOULD | MAY | SHOULD-NOT (new)
      Comments

      Element Requirements.statement.conformance is part of an existing definition because parent element Requirements.statement requires a cross-version extension. Element Requirements.statement.conformance is not mapped to FHIR R4, since FHIR R5 Requirements is not mapped. Element Requirements.statement.conformance has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). 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)

      Control0..*
      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. Element Requirements.statement.conformance is part of an existing definition because parent element Requirements.statement requires a cross-version extension. Element Requirements.statement.conformance is not mapped to FHIR R4, since FHIR R5 Requirements is not mapped. Element Requirements.statement.conformance has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

      18. Extension.extension:conformance.url
      Control1..1
      Fixed Valueconformance
      20. Extension.extension:conformance.value[x]
      Definition

      A short human usable label for this statement.

      ShortSHALL | SHOULD | MAY | SHOULD-NOT
      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)

      Control0..1
      BindingThe codes SHALL be taken from R5ConformanceExpectationForR4 (0.1.0)
      (required to http://hl7.org/fhir/uv/xver/ValueSet/R5-conformance-expectation-for-R4|0.1.0)
      Typecode
      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      22. Extension.extension:conditionality
      Slice Nameconditionality
      Definition

      R5: Requirements.statement.conditionality (new:boolean)

      ShortR5: Set to true if requirements statement is conditional (new)
      Comments

      Element Requirements.statement.conditionality is part of an existing definition because parent element Requirements.statement requires a cross-version extension. Element Requirements.statement.conditionality is not mapped to FHIR R4, since FHIR R5 Requirements is not mapped. Element Requirements.statement.conditionality has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). There is no intent that the conditional statement by evaluatable

      Control0..1
      Requirements

      Element Requirements.statement.conditionality is part of an existing definition because parent element Requirements.statement requires a cross-version extension. Element Requirements.statement.conditionality is not mapped to FHIR R4, since FHIR R5 Requirements is not mapped. Element Requirements.statement.conditionality has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

      24. Extension.extension:conditionality.url
      Control1..1
      Fixed Valueconditionality
      26. Extension.extension:conditionality.value[x]
      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.

      ShortSet to true if requirements statement is conditional
      Comments

      There is no intent that the conditional statement by evaluatable

      Control0..1
      Typeboolean
      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      28. Extension.extension:requirement
      Slice Namerequirement
      Definition

      R5: Requirements.statement.requirement (new:markdown)

      ShortR5: The actual requirement (new)
      Comments

      Element Requirements.statement.requirement is part of an existing definition because parent element Requirements.statement requires a cross-version extension. Element Requirements.statement.requirement is not mapped to FHIR R4, since FHIR R5 Requirements is not mapped. Element Requirements.statement.requirement has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

      Control1..1
      Requirements

      Element Requirements.statement.requirement is part of an existing definition because parent element Requirements.statement requires a cross-version extension. Element Requirements.statement.requirement is not mapped to FHIR R4, since FHIR R5 Requirements is not mapped. Element Requirements.statement.requirement has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

      30. Extension.extension:requirement.url
      Control1..1
      Fixed Valuerequirement
      32. Extension.extension:requirement.value[x]
      Definition

      The actual requirement for human consumption.

      ShortThe actual requirement
      Control1..1
      Typemarkdown
      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      34. Extension.extension:derivedFrom
      Slice NamederivedFrom
      Definition

      R5: Requirements.statement.derivedFrom (new:string)

      ShortR5: Another statement this clarifies/restricts ([url#]key) (new)
      Comments

      Element Requirements.statement.derivedFrom is part of an existing definition because parent element Requirements.statement requires a cross-version extension. Element Requirements.statement.derivedFrom is not mapped to FHIR R4, since FHIR R5 Requirements is not mapped. Element Requirements.statement.derivedFrom has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). 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

      Control0..1
      Requirements

      Element Requirements.statement.derivedFrom is part of an existing definition because parent element Requirements.statement requires a cross-version extension. Element Requirements.statement.derivedFrom is not mapped to FHIR R4, since FHIR R5 Requirements is not mapped. Element Requirements.statement.derivedFrom has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

      36. Extension.extension:derivedFrom.url
      Control1..1
      Fixed ValuederivedFrom
      38. Extension.extension:derivedFrom.value[x]
      Definition

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

      ShortAnother statement this clarifies/restricts ([url#]key)
      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

      Control0..1
      Typestring
      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      40. Extension.extension:parent
      Slice Nameparent
      Definition

      R5: Requirements.statement.parent (new:string)

      ShortR5: A larger requirement that this requirement helps to refine and enable (new)
      Comments

      Element Requirements.statement.parent is part of an existing definition because parent element Requirements.statement requires a cross-version extension. Element Requirements.statement.parent is not mapped to FHIR R4, since FHIR R5 Requirements is not mapped. Element Requirements.statement.parent has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). 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.

      Control0..1
      Requirements

      Allows requirements to be organized compositionally. E.g. Epic/Story/Task. Element Requirements.statement.parent is part of an existing definition because parent element Requirements.statement requires a cross-version extension. Element Requirements.statement.parent is not mapped to FHIR R4, since FHIR R5 Requirements is not mapped. Element Requirements.statement.parent has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

      42. Extension.extension:parent.url
      Control1..1
      Fixed Valueparent
      44. Extension.extension:parent.value[x]
      Definition

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

      ShortA larger requirement that this requirement helps to refine and enable
      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.

      Control0..1
      Typestring
      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      46. Extension.extension:satisfiedBy
      Slice NamesatisfiedBy
      Definition

      R5: Requirements.statement.satisfiedBy (new:url)

      ShortR5: Design artifact that satisfies this requirement (new)
      Comments

      Element Requirements.statement.satisfiedBy is part of an existing definition because parent element Requirements.statement requires a cross-version extension. Element Requirements.statement.satisfiedBy is not mapped to FHIR R4, since FHIR R5 Requirements is not mapped. Element Requirements.statement.satisfiedBy has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). 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.

      Control0..*
      Requirements

      Element Requirements.statement.satisfiedBy is part of an existing definition because parent element Requirements.statement requires a cross-version extension. Element Requirements.statement.satisfiedBy is not mapped to FHIR R4, since FHIR R5 Requirements is not mapped. Element Requirements.statement.satisfiedBy has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

      48. Extension.extension:satisfiedBy.url
      Control1..1
      Fixed ValuesatisfiedBy
      50. Extension.extension:satisfiedBy.value[x]
      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.

      ShortDesign artifact that satisfies this requirement
      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.

      Control0..1
      Typeurl
      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      52. Extension.extension:reference
      Slice Namereference
      Definition

      R5: Requirements.statement.reference (new:url)

      ShortR5: External artifact (rule/document etc. that) created this requirement (new)
      Comments

      Element Requirements.statement.reference is part of an existing definition because parent element Requirements.statement requires a cross-version extension. Element Requirements.statement.reference is not mapped to FHIR R4, since FHIR R5 Requirements is not mapped. Element Requirements.statement.reference has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

      Control0..*
      Requirements

      Element Requirements.statement.reference is part of an existing definition because parent element Requirements.statement requires a cross-version extension. Element Requirements.statement.reference is not mapped to FHIR R4, since FHIR R5 Requirements is not mapped. Element Requirements.statement.reference has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

      54. Extension.extension:reference.url
      Control1..1
      Fixed Valuereference
      56. Extension.extension:reference.value[x]
      Definition

      A reference to another artifact that created this requirement. This could be a Profile, etc., or external regulation, or business requirements expressed elsewhere.

      ShortExternal artifact (rule/document etc. that) created this requirement
      Control0..1
      Typeurl
      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      58. Extension.extension:source
      Slice Namesource
      Definition

      R5: Requirements.statement.source (new:Reference(CareTeam,Device,Group,HealthcareService,Organization,Patient,Practitioner,PractitionerRole,RelatedPerson))

      ShortR5: Who asked for this statement (new)
      Comments

      Element Requirements.statement.source is part of an existing definition because parent element Requirements.statement requires a cross-version extension. Element Requirements.statement.source is not mapped to FHIR R4, since FHIR R5 Requirements is not mapped. Element Requirements.statement.source has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

      Control0..*
      Requirements

      Element Requirements.statement.source is part of an existing definition because parent element Requirements.statement requires a cross-version extension. Element Requirements.statement.source is not mapped to FHIR R4, since FHIR R5 Requirements is not mapped. Element Requirements.statement.source has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

      60. Extension.extension:source.url
      Control1..1
      Fixed Valuesource
      62. Extension.extension:source.value[x]
      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.

      ShortWho asked for this statement
      Control0..1
      TypeReference(Cross-version Profile for R5.CareTeam for use in FHIR R4, CareTeam, Cross-version Profile for R5.Device for use in FHIR R4, Device, Cross-version Profile for R5.Group for use in FHIR R4, Group, Cross-version Profile for R5.HealthcareService for use in FHIR R4, HealthcareService, Cross-version Profile for R5.Organization for use in FHIR R4, Organization, Cross-version Profile for R5.Patient for use in FHIR R4, Patient, Cross-version Profile for R5.Practitioner for use in FHIR R4, Practitioner, Cross-version Profile for R5.PractitionerRole for use in FHIR R4, PractitionerRole, Cross-version Profile for R5.RelatedPerson for use in FHIR R4, RelatedPerson)
      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
      64. Extension.url
      Control1..1
      Fixed Valuehttp://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.statement
      66. Extension.value[x]
      Control0..0

      Guidance on how to interpret the contents of this table can be foundhere

      0. Extension
      Definition

      R5: Requirements.statement (new:BackboneElement)

      ShortR5: Actual statement as markdown (new)
      Comments

      Element Requirements.statement is not mapped to FHIR R4, since FHIR R5 Requirements is not mapped. Element Requirements.statement has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

      Control0..*
      This element is affected by the following invariants: ele-1
      Is Modifierfalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      2. Extension.id
      Definition

      Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

      ShortUnique id for inter-element referencing
      Control0..1
      Typestring
      Is Modifierfalse
      XML FormatIn the XML format, this property is represented as an attribute.
      Summaryfalse
      4. Extension.extension
      Definition

      An Extension

      ShortExtension
      Control2..*
      TypeExtension
      Is Modifierfalse
      Summaryfalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      SlicingThis element introduces a set of slices on Extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
      • value @ url
      • 6. Extension.extension:key
        Slice Namekey
        Definition

        R5: Requirements.statement.key (new:id)

        ShortR5: Key that identifies this statement (new)
        Comments

        Element Requirements.statement.key is part of an existing definition because parent element Requirements.statement requires a cross-version extension. Element Requirements.statement.key is not mapped to FHIR R4, since FHIR R5 Requirements is not mapped. Element Requirements.statement.key has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). Refer directly to the statement by {url}#{key}

        Control1..1
        TypeExtension
        Is Modifierfalse
        Summaryfalse
        Requirements

        Element Requirements.statement.key is part of an existing definition because parent element Requirements.statement requires a cross-version extension. Element Requirements.statement.key is not mapped to FHIR R4, since FHIR R5 Requirements is not mapped. Element Requirements.statement.key has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        8. Extension.extension:key.id
        Definition

        Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

        ShortUnique id for inter-element referencing
        Control0..1
        Typestring
        Is Modifierfalse
        XML FormatIn the XML format, this property is represented as an attribute.
        Summaryfalse
        10. Extension.extension:key.extension
        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 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.

        ShortAdditional content defined by implementations
        Comments

        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.

        Control0..*
        TypeExtension
        Is Modifierfalse
        Summaryfalse
        Alternate Namesextensions, user content
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        SlicingThis element introduces a set of slices on Extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
        • value @ url
        • 12. Extension.extension:key.url
          Definition

          Source of the definition for the extension code - a logical name or a URL.

          Shortidentifies the meaning of the extension
          Comments

          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.

          Control1..1
          Typeuri
          Is Modifierfalse
          XML FormatIn the XML format, this property is represented as an attribute.
          Summaryfalse
          Fixed Valuekey
          14. Extension.extension:key.value[x]
          Definition

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

          ShortKey that identifies this statement
          Comments

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

          Control1..1
          Typeid
          [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
          Is Modifierfalse
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Summaryfalse
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          16. Extension.extension:label
          Slice Namelabel
          Definition

          R5: Requirements.statement.label (new:string)

          ShortR5: Short Human label for this statement (new)
          Comments

          Element Requirements.statement.label is part of an existing definition because parent element Requirements.statement requires a cross-version extension. Element Requirements.statement.label is not mapped to FHIR R4, since FHIR R5 Requirements is not mapped. Element Requirements.statement.label has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). 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)

          Control0..1
          TypeExtension
          Is Modifierfalse
          Summaryfalse
          Requirements

          Element Requirements.statement.label is part of an existing definition because parent element Requirements.statement requires a cross-version extension. Element Requirements.statement.label is not mapped to FHIR R4, since FHIR R5 Requirements is not mapped. Element Requirements.statement.label has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
          18. Extension.extension:label.id
          Definition

          Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

          ShortUnique id for inter-element referencing
          Control0..1
          Typestring
          Is Modifierfalse
          XML FormatIn the XML format, this property is represented as an attribute.
          Summaryfalse
          20. Extension.extension:label.extension
          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 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.

          ShortAdditional content defined by implementations
          Comments

          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.

          Control0..*
          TypeExtension
          Is Modifierfalse
          Summaryfalse
          Alternate Namesextensions, user content
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
          SlicingThis element introduces a set of slices on Extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
          • value @ url
          • 22. Extension.extension:label.url
            Definition

            Source of the definition for the extension code - a logical name or a URL.

            Shortidentifies the meaning of the extension
            Comments

            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.

            Control1..1
            Typeuri
            Is Modifierfalse
            XML FormatIn the XML format, this property is represented as an attribute.
            Summaryfalse
            Fixed Valuelabel
            24. Extension.extension:label.value[x]
            Definition

            A short human usable label for this statement.

            ShortShort Human label for this statement
            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)

            Control0..1
            Typestring
            [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summaryfalse
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            26. Extension.extension:conformance
            Slice Nameconformance
            Definition

            R5: Requirements.statement.conformance (new:code)

            ShortR5: SHALL | SHOULD | MAY | SHOULD-NOT (new)
            Comments

            Element Requirements.statement.conformance is part of an existing definition because parent element Requirements.statement requires a cross-version extension. Element Requirements.statement.conformance is not mapped to FHIR R4, since FHIR R5 Requirements is not mapped. Element Requirements.statement.conformance has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). 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)

            Control0..*
            TypeExtension
            Is Modifierfalse
            Summaryfalse
            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. Element Requirements.statement.conformance is part of an existing definition because parent element Requirements.statement requires a cross-version extension. Element Requirements.statement.conformance is not mapped to FHIR R4, since FHIR R5 Requirements is not mapped. Element Requirements.statement.conformance has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
            28. Extension.extension:conformance.id
            Definition

            Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

            ShortUnique id for inter-element referencing
            Control0..1
            Typestring
            Is Modifierfalse
            XML FormatIn the XML format, this property is represented as an attribute.
            Summaryfalse
            30. Extension.extension:conformance.extension
            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 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.

            ShortAdditional content defined by implementations
            Comments

            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.

            Control0..*
            TypeExtension
            Is Modifierfalse
            Summaryfalse
            Alternate Namesextensions, user content
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
            SlicingThis element introduces a set of slices on Extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
            • value @ url
            • 32. Extension.extension:conformance.url
              Definition

              Source of the definition for the extension code - a logical name or a URL.

              Shortidentifies the meaning of the extension
              Comments

              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.

              Control1..1
              Typeuri
              Is Modifierfalse
              XML FormatIn the XML format, this property is represented as an attribute.
              Summaryfalse
              Fixed Valueconformance
              34. Extension.extension:conformance.value[x]
              Definition

              A short human usable label for this statement.

              ShortSHALL | SHOULD | MAY | SHOULD-NOT
              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)

              Control0..1
              BindingThe codes SHALL be taken from R5ConformanceExpectationForR4 (0.1.0)
              (required to http://hl7.org/fhir/uv/xver/ValueSet/R5-conformance-expectation-for-R4|0.1.0)
              Typecode
              [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
              Is Modifierfalse
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summaryfalse
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              36. Extension.extension:conditionality
              Slice Nameconditionality
              Definition

              R5: Requirements.statement.conditionality (new:boolean)

              ShortR5: Set to true if requirements statement is conditional (new)
              Comments

              Element Requirements.statement.conditionality is part of an existing definition because parent element Requirements.statement requires a cross-version extension. Element Requirements.statement.conditionality is not mapped to FHIR R4, since FHIR R5 Requirements is not mapped. Element Requirements.statement.conditionality has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). There is no intent that the conditional statement by evaluatable

              Control0..1
              TypeExtension
              Is Modifierfalse
              Summaryfalse
              Requirements

              Element Requirements.statement.conditionality is part of an existing definition because parent element Requirements.statement requires a cross-version extension. Element Requirements.statement.conditionality is not mapped to FHIR R4, since FHIR R5 Requirements is not mapped. Element Requirements.statement.conditionality has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
              38. Extension.extension:conditionality.id
              Definition

              Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

              ShortUnique id for inter-element referencing
              Control0..1
              Typestring
              Is Modifierfalse
              XML FormatIn the XML format, this property is represented as an attribute.
              Summaryfalse
              40. Extension.extension:conditionality.extension
              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 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.

              ShortAdditional content defined by implementations
              Comments

              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.

              Control0..*
              TypeExtension
              Is Modifierfalse
              Summaryfalse
              Alternate Namesextensions, user content
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
              SlicingThis element introduces a set of slices on Extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
              • value @ url
              • 42. Extension.extension:conditionality.url
                Definition

                Source of the definition for the extension code - a logical name or a URL.

                Shortidentifies the meaning of the extension
                Comments

                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.

                Control1..1
                Typeuri
                Is Modifierfalse
                XML FormatIn the XML format, this property is represented as an attribute.
                Summaryfalse
                Fixed Valueconditionality
                44. Extension.extension:conditionality.value[x]
                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.

                ShortSet to true if requirements statement is conditional
                Comments

                There is no intent that the conditional statement by evaluatable

                Control0..1
                Typeboolean
                [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                Is Modifierfalse
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                Summaryfalse
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                46. Extension.extension:requirement
                Slice Namerequirement
                Definition

                R5: Requirements.statement.requirement (new:markdown)

                ShortR5: The actual requirement (new)
                Comments

                Element Requirements.statement.requirement is part of an existing definition because parent element Requirements.statement requires a cross-version extension. Element Requirements.statement.requirement is not mapped to FHIR R4, since FHIR R5 Requirements is not mapped. Element Requirements.statement.requirement has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

                Control1..1
                TypeExtension
                Is Modifierfalse
                Summaryfalse
                Requirements

                Element Requirements.statement.requirement is part of an existing definition because parent element Requirements.statement requires a cross-version extension. Element Requirements.statement.requirement is not mapped to FHIR R4, since FHIR R5 Requirements is not mapped. Element Requirements.statement.requirement has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                48. Extension.extension:requirement.id
                Definition

                Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                ShortUnique id for inter-element referencing
                Control0..1
                Typestring
                Is Modifierfalse
                XML FormatIn the XML format, this property is represented as an attribute.
                Summaryfalse
                50. Extension.extension:requirement.extension
                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 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.

                ShortAdditional content defined by implementations
                Comments

                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.

                Control0..*
                TypeExtension
                Is Modifierfalse
                Summaryfalse
                Alternate Namesextensions, user content
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                SlicingThis element introduces a set of slices on Extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                • value @ url
                • 52. Extension.extension:requirement.url
                  Definition

                  Source of the definition for the extension code - a logical name or a URL.

                  Shortidentifies the meaning of the extension
                  Comments

                  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.

                  Control1..1
                  Typeuri
                  Is Modifierfalse
                  XML FormatIn the XML format, this property is represented as an attribute.
                  Summaryfalse
                  Fixed Valuerequirement
                  54. Extension.extension:requirement.value[x]
                  Definition

                  The actual requirement for human consumption.

                  ShortThe actual requirement
                  Control1..1
                  Typemarkdown
                  [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                  Is Modifierfalse
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Summaryfalse
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  56. Extension.extension:derivedFrom
                  Slice NamederivedFrom
                  Definition

                  R5: Requirements.statement.derivedFrom (new:string)

                  ShortR5: Another statement this clarifies/restricts ([url#]key) (new)
                  Comments

                  Element Requirements.statement.derivedFrom is part of an existing definition because parent element Requirements.statement requires a cross-version extension. Element Requirements.statement.derivedFrom is not mapped to FHIR R4, since FHIR R5 Requirements is not mapped. Element Requirements.statement.derivedFrom has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). 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

                  Control0..1
                  TypeExtension
                  Is Modifierfalse
                  Summaryfalse
                  Requirements

                  Element Requirements.statement.derivedFrom is part of an existing definition because parent element Requirements.statement requires a cross-version extension. Element Requirements.statement.derivedFrom is not mapped to FHIR R4, since FHIR R5 Requirements is not mapped. Element Requirements.statement.derivedFrom has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                  58. Extension.extension:derivedFrom.id
                  Definition

                  Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                  ShortUnique id for inter-element referencing
                  Control0..1
                  Typestring
                  Is Modifierfalse
                  XML FormatIn the XML format, this property is represented as an attribute.
                  Summaryfalse
                  60. Extension.extension:derivedFrom.extension
                  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 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.

                  ShortAdditional content defined by implementations
                  Comments

                  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.

                  Control0..*
                  TypeExtension
                  Is Modifierfalse
                  Summaryfalse
                  Alternate Namesextensions, user content
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                  SlicingThis element introduces a set of slices on Extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                  • value @ url
                  • 62. Extension.extension:derivedFrom.url
                    Definition

                    Source of the definition for the extension code - a logical name or a URL.

                    Shortidentifies the meaning of the extension
                    Comments

                    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.

                    Control1..1
                    Typeuri
                    Is Modifierfalse
                    XML FormatIn the XML format, this property is represented as an attribute.
                    Summaryfalse
                    Fixed ValuederivedFrom
                    64. Extension.extension:derivedFrom.value[x]
                    Definition

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

                    ShortAnother statement this clarifies/restricts ([url#]key)
                    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

                    Control0..1
                    Typestring
                    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                    Is Modifierfalse
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    Summaryfalse
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    66. Extension.extension:parent
                    Slice Nameparent
                    Definition

                    R5: Requirements.statement.parent (new:string)

                    ShortR5: A larger requirement that this requirement helps to refine and enable (new)
                    Comments

                    Element Requirements.statement.parent is part of an existing definition because parent element Requirements.statement requires a cross-version extension. Element Requirements.statement.parent is not mapped to FHIR R4, since FHIR R5 Requirements is not mapped. Element Requirements.statement.parent has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). 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.

                    Control0..1
                    TypeExtension
                    Is Modifierfalse
                    Summaryfalse
                    Requirements

                    Allows requirements to be organized compositionally. E.g. Epic/Story/Task. Element Requirements.statement.parent is part of an existing definition because parent element Requirements.statement requires a cross-version extension. Element Requirements.statement.parent is not mapped to FHIR R4, since FHIR R5 Requirements is not mapped. Element Requirements.statement.parent has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                    68. Extension.extension:parent.id
                    Definition

                    Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                    ShortUnique id for inter-element referencing
                    Control0..1
                    Typestring
                    Is Modifierfalse
                    XML FormatIn the XML format, this property is represented as an attribute.
                    Summaryfalse
                    70. Extension.extension:parent.extension
                    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 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.

                    ShortAdditional content defined by implementations
                    Comments

                    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.

                    Control0..*
                    TypeExtension
                    Is Modifierfalse
                    Summaryfalse
                    Alternate Namesextensions, user content
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                    SlicingThis element introduces a set of slices on Extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                    • value @ url
                    • 72. Extension.extension:parent.url
                      Definition

                      Source of the definition for the extension code - a logical name or a URL.

                      Shortidentifies the meaning of the extension
                      Comments

                      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.

                      Control1..1
                      Typeuri
                      Is Modifierfalse
                      XML FormatIn the XML format, this property is represented as an attribute.
                      Summaryfalse
                      Fixed Valueparent
                      74. Extension.extension:parent.value[x]
                      Definition

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

                      ShortA larger requirement that this requirement helps to refine and enable
                      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.

                      Control0..1
                      Typestring
                      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                      Is Modifierfalse
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Summaryfalse
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      76. Extension.extension:satisfiedBy
                      Slice NamesatisfiedBy
                      Definition

                      R5: Requirements.statement.satisfiedBy (new:url)

                      ShortR5: Design artifact that satisfies this requirement (new)
                      Comments

                      Element Requirements.statement.satisfiedBy is part of an existing definition because parent element Requirements.statement requires a cross-version extension. Element Requirements.statement.satisfiedBy is not mapped to FHIR R4, since FHIR R5 Requirements is not mapped. Element Requirements.statement.satisfiedBy has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). 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.

                      Control0..*
                      TypeExtension
                      Is Modifierfalse
                      Summaryfalse
                      Requirements

                      Element Requirements.statement.satisfiedBy is part of an existing definition because parent element Requirements.statement requires a cross-version extension. Element Requirements.statement.satisfiedBy is not mapped to FHIR R4, since FHIR R5 Requirements is not mapped. Element Requirements.statement.satisfiedBy has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                      78. Extension.extension:satisfiedBy.id
                      Definition

                      Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                      ShortUnique id for inter-element referencing
                      Control0..1
                      Typestring
                      Is Modifierfalse
                      XML FormatIn the XML format, this property is represented as an attribute.
                      Summaryfalse
                      80. Extension.extension:satisfiedBy.extension
                      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 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.

                      ShortAdditional content defined by implementations
                      Comments

                      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.

                      Control0..*
                      TypeExtension
                      Is Modifierfalse
                      Summaryfalse
                      Alternate Namesextensions, user content
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                      SlicingThis element introduces a set of slices on Extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                      • value @ url
                      • 82. Extension.extension:satisfiedBy.url
                        Definition

                        Source of the definition for the extension code - a logical name or a URL.

                        Shortidentifies the meaning of the extension
                        Comments

                        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.

                        Control1..1
                        Typeuri
                        Is Modifierfalse
                        XML FormatIn the XML format, this property is represented as an attribute.
                        Summaryfalse
                        Fixed ValuesatisfiedBy
                        84. Extension.extension:satisfiedBy.value[x]
                        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.

                        ShortDesign artifact that satisfies this requirement
                        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.

                        Control0..1
                        Typeurl
                        [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Summaryfalse
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        86. Extension.extension:reference
                        Slice Namereference
                        Definition

                        R5: Requirements.statement.reference (new:url)

                        ShortR5: External artifact (rule/document etc. that) created this requirement (new)
                        Comments

                        Element Requirements.statement.reference is part of an existing definition because parent element Requirements.statement requires a cross-version extension. Element Requirements.statement.reference is not mapped to FHIR R4, since FHIR R5 Requirements is not mapped. Element Requirements.statement.reference has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

                        Control0..*
                        TypeExtension
                        Is Modifierfalse
                        Summaryfalse
                        Requirements

                        Element Requirements.statement.reference is part of an existing definition because parent element Requirements.statement requires a cross-version extension. Element Requirements.statement.reference is not mapped to FHIR R4, since FHIR R5 Requirements is not mapped. Element Requirements.statement.reference has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                        88. Extension.extension:reference.id
                        Definition

                        Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                        ShortUnique id for inter-element referencing
                        Control0..1
                        Typestring
                        Is Modifierfalse
                        XML FormatIn the XML format, this property is represented as an attribute.
                        Summaryfalse
                        90. Extension.extension:reference.extension
                        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 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.

                        ShortAdditional content defined by implementations
                        Comments

                        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.

                        Control0..*
                        TypeExtension
                        Is Modifierfalse
                        Summaryfalse
                        Alternate Namesextensions, user content
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                        SlicingThis element introduces a set of slices on Extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                        • value @ url
                        • 92. Extension.extension:reference.url
                          Definition

                          Source of the definition for the extension code - a logical name or a URL.

                          Shortidentifies the meaning of the extension
                          Comments

                          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.

                          Control1..1
                          Typeuri
                          Is Modifierfalse
                          XML FormatIn the XML format, this property is represented as an attribute.
                          Summaryfalse
                          Fixed Valuereference
                          94. Extension.extension:reference.value[x]
                          Definition

                          A reference to another artifact that created this requirement. This could be a Profile, etc., or external regulation, or business requirements expressed elsewhere.

                          ShortExternal artifact (rule/document etc. that) created this requirement
                          Control0..1
                          Typeurl
                          [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                          Is Modifierfalse
                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                          Summaryfalse
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          96. Extension.extension:source
                          Slice Namesource
                          Definition

                          R5: Requirements.statement.source (new:Reference(CareTeam,Device,Group,HealthcareService,Organization,Patient,Practitioner,PractitionerRole,RelatedPerson))

                          ShortR5: Who asked for this statement (new)
                          Comments

                          Element Requirements.statement.source is part of an existing definition because parent element Requirements.statement requires a cross-version extension. Element Requirements.statement.source is not mapped to FHIR R4, since FHIR R5 Requirements is not mapped. Element Requirements.statement.source has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

                          Control0..*
                          TypeExtension
                          Is Modifierfalse
                          Summaryfalse
                          Requirements

                          Element Requirements.statement.source is part of an existing definition because parent element Requirements.statement requires a cross-version extension. Element Requirements.statement.source is not mapped to FHIR R4, since FHIR R5 Requirements is not mapped. Element Requirements.statement.source has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                          98. Extension.extension:source.id
                          Definition

                          Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                          ShortUnique id for inter-element referencing
                          Control0..1
                          Typestring
                          Is Modifierfalse
                          XML FormatIn the XML format, this property is represented as an attribute.
                          Summaryfalse
                          100. Extension.extension:source.extension
                          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 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.

                          ShortAdditional content defined by implementations
                          Comments

                          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.

                          Control0..*
                          TypeExtension
                          Is Modifierfalse
                          Summaryfalse
                          Alternate Namesextensions, user content
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                          SlicingThis element introduces a set of slices on Extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                          • value @ url
                          • 102. Extension.extension:source.url
                            Definition

                            Source of the definition for the extension code - a logical name or a URL.

                            Shortidentifies the meaning of the extension
                            Comments

                            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.

                            Control1..1
                            Typeuri
                            Is Modifierfalse
                            XML FormatIn the XML format, this property is represented as an attribute.
                            Summaryfalse
                            Fixed Valuesource
                            104. Extension.extension:source.value[x]
                            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.

                            ShortWho asked for this statement
                            Control0..1
                            TypeReference(Cross-version Profile for R5.CareTeam for use in FHIR R4, CareTeam, Cross-version Profile for R5.Device for use in FHIR R4, Device, Cross-version Profile for R5.Group for use in FHIR R4, Group, Cross-version Profile for R5.HealthcareService for use in FHIR R4, HealthcareService, Cross-version Profile for R5.Organization for use in FHIR R4, Organization, Cross-version Profile for R5.Patient for use in FHIR R4, Patient, Cross-version Profile for R5.Practitioner for use in FHIR R4, Practitioner, Cross-version Profile for R5.PractitionerRole for use in FHIR R4, PractitionerRole, Cross-version Profile for R5.RelatedPerson for use in FHIR R4, RelatedPerson)
                            [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                            Is Modifierfalse
                            Summaryfalse
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            106. Extension.url
                            Definition

                            Source of the definition for the extension code - a logical name or a URL.

                            Shortidentifies the meaning of the extension
                            Comments

                            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.

                            Control1..1
                            Typeuri
                            Is Modifierfalse
                            XML FormatIn the XML format, this property is represented as an attribute.
                            Summaryfalse
                            Fixed Valuehttp://hl7.org/fhir/5.0/StructureDefinition/extension-Requirements.statement
                            108. Extension.value[x]
                            Definition

                            Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

                            ShortValue of extension
                            Control0..0
                            TypeChoice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta
                            Is Modifierfalse
                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                            Summaryfalse
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))