PACIO Personal Functioning and Engagement Implementation Guide
3.0.0-ballot - STU 3 Ballot United States of America flag

PACIO Personal Functioning and Engagement Implementation Guide, published by HL7 International / Patient Care. This guide is not an authorized publication; it is the continuous build for version 3.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-pacio-pfe/ and changes regularly. See the Directory of published versions

Extension: PFE Nutrition Intake Status - Detailed Descriptions

Page standards status: Trial-use Maturity Level: 3

Definitions for the pfe-nutrition-intake-status extension

See the documentation on how to interpret the contents of this table

0. Extension
Definition

The status of a nutrition intake, using the required EventStatus binding from FHIR R5 NutritionIntake.status. Replaces the incompatible status binding in the R5-to-R4 cross-version package 0.1.0.


Optional Extension Element - found in all resources.

ShortPFE Nutrition Intake StatusOptional Extensions Element
Control0..*
This element is affected by the following invariants: ele-1
Is Modifiertruefalse because The entered-in-error status means that the nutrition intake resource should not be treated as valid.
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())
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.

Control0..0*
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. The slices are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
4. 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 Value
{
  "url" : "http://hl7.org/fhir/us/pacio-pfe/StructureDefinition/pfe-nutrition-intake-status"
}
<url value="http://hl7.org/fhir/us/pacio-pfe/StructureDefinition/pfe-nutrition-intake-status"/>
6. Extension.value[x]
Definition

A code representing the patient or other source's judgment about the state of the intake that this assertion is about. Generally, this will be active or completed.


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

Shortpreparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknownValue of extension
Comments

NutritionIntake is a statement at a point in time. The status is only representative at the point when it was asserted. The value set for NutritionIntake.status contains codes that assert the status of the consumption of the food or fluid by the patient (for example, stopped or on hold) as well as codes that assert the status of the Nutrition Intake itself (for example, entered in error).

This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.

Control10..1
BindingThe codes SHALL be taken from For codes, see EventStatus
(required to http://hl7.org/fhir/ValueSet/event-status)
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()))

See the documentation on how to interpret the contents of this table

0. Extension
Definition

The status of a nutrition intake, using the required EventStatus binding from FHIR R5 NutritionIntake.status. Replaces the incompatible status binding in the R5-to-R4 cross-version package 0.1.0.

ShortPFE Nutrition Intake Status
Is Modifiertrue because The entered-in-error status means that the nutrition intake resource should not be treated as valid.
2. Extension.extension
Control0..0
4. Extension.url
Fixed Value
{
  "url" : "http://hl7.org/fhir/us/pacio-pfe/StructureDefinition/pfe-nutrition-intake-status"
}
<url value="http://hl7.org/fhir/us/pacio-pfe/StructureDefinition/pfe-nutrition-intake-status"/>
6. Extension.value[x]
Definition

A code representing the patient or other source's judgment about the state of the intake that this assertion is about. Generally, this will be active or completed.

Shortpreparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown
Comments

NutritionIntake is a statement at a point in time. The status is only representative at the point when it was asserted. The value set for NutritionIntake.status contains codes that assert the status of the consumption of the food or fluid by the patient (for example, stopped or on hold) as well as codes that assert the status of the Nutrition Intake itself (for example, entered in error).

This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.

Control1..?
BindingThe codes SHALL be taken from EventStatus
(required to http://hl7.org/fhir/ValueSet/event-status)
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]
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension

See the documentation on how to interpret the contents of this table

0. Extension
Definition

The status of a nutrition intake, using the required EventStatus binding from FHIR R5 NutritionIntake.status. Replaces the incompatible status binding in the R5-to-R4 cross-version package 0.1.0.

ShortPFE Nutrition Intake Status
Control0..*
This element is affected by the following invariants: ele-1
Is Modifiertrue because The entered-in-error status means that the nutrition intake resource should not be treated as valid.
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
Control0..0
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 are Unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
6. 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 Value
{
  "url" : "http://hl7.org/fhir/us/pacio-pfe/StructureDefinition/pfe-nutrition-intake-status"
}
<url value="http://hl7.org/fhir/us/pacio-pfe/StructureDefinition/pfe-nutrition-intake-status"/>
8. Extension.value[x]
Definition

A code representing the patient or other source's judgment about the state of the intake that this assertion is about. Generally, this will be active or completed.

Shortpreparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown
Comments

NutritionIntake is a statement at a point in time. The status is only representative at the point when it was asserted. The value set for NutritionIntake.status contains codes that assert the status of the consumption of the food or fluid by the patient (for example, stopped or on hold) as well as codes that assert the status of the Nutrition Intake itself (for example, entered in error).

This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.

Control1..1
BindingThe codes SHALL be taken from EventStatus
(required to http://hl7.org/fhir/ValueSet/event-status)
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()))