IKNL PZP STU3
1.0.0-rc1 - consultation International flag

This page is part of the Advance Care Planning (PZP) (v1.0.0-rc1: Release 1) based on FHIR (HL7® FHIR® Standard) R3. No current official version has been published yet. For a full list of available versions, see the Directory of published versions

Extension: ExtEncounterReference - Detailed Descriptions

Draft as of 2025-10-30

Definitions for the ext-EncounterReference extension.

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

0. Extension
Definition

An extension to link the Encounter during which the Consent, Goal or DeviceUseStatement was created or to which the creation is tightly associated.


Base definition for all elements in a resource.

Shortext Encounter ReferenceBase for all elements
Control0..*
This element is affected by the following invariants: ele-1
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (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() | (children().count() > id.count()))
2. Extension.extension
Definition

An Extension


May be used to represent additional information that is not part of the basic definition of the element. In order 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 is allowed to 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*
This element is affected by the following invariants: ele-1
TypeExtension
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (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.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
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    Fixed Valuehttps://api.iknl.nl/docs/pzp/stu3/StructureDefinition/ext-EncounterReference
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
    ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
    6. Extension.value[x]
    Definition

    The Encounter during which this resource was created or to which the creation is tightly associated.


    Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

    ShortEncounterValue of extension
    Comments

    This will typically be the encounter the event occurred within, but some activities may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter (e.g. completing the administrative registration after the encounter).

    Control0..1
    This element is affected by the following invariants: ele-1
    TypeReference(Encounter), date, dateTime, Meta, code, string, Address, Attachment, integer, oid, Count, instant, ContactPoint, HumanName, Money, Identifier, Coding, markdown, SampledData, Ratio, id, positiveInt, Age, Distance, Period, Quantity, Duration, Range, uri, Annotation, boolean, base64Binary, Signature, unsignedInt, time, Timing, decimal, CodeableConcept
    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
    ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))

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

    0. Extension
    Definition

    An extension to link the Encounter during which the Consent, Goal or DeviceUseStatement was created or to which the creation is tightly associated.

    Shortext Encounter Reference
    2. Extension.extension
    Control0..0
    4. Extension.url
    Fixed Valuehttps://api.iknl.nl/docs/pzp/stu3/StructureDefinition/ext-EncounterReference
    6. Extension.value[x]
    Definition

    The Encounter during which this resource was created or to which the creation is tightly associated.

    ShortEncounter
    Comments

    This will typically be the encounter the event occurred within, but some activities may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter (e.g. completing the administrative registration after the encounter).

    TypeReference(Encounter), date, dateTime, Meta, code, string, Address, Attachment, integer, oid, Count, instant, ContactPoint, HumanName, Money, Identifier, Coding, markdown, SampledData, Ratio, id, positiveInt, Age, Distance, Period, Quantity, Duration, Range, uri, Annotation, boolean, base64Binary, Signature, unsignedInt, time, Timing, decimal, CodeableConcept
    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]

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

    0. Extension
    Definition

    An extension to link the Encounter during which the Consent, Goal or DeviceUseStatement was created or to which the creation is tightly associated.

    Shortext Encounter Reference
    Control0..*
    This element is affected by the following invariants: ele-1
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (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.

    Shortxml:id (or equivalent in JSON)
    Control0..1
    Typestring
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    4. Extension.extension
    Definition

    An Extension

    ShortExtension
    Control0..0
    TypeExtension
    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.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
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      XML FormatIn the XML format, this property is represented as an attribute.
      Fixed Valuehttps://api.iknl.nl/docs/pzp/stu3/StructureDefinition/ext-EncounterReference
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
      8. Extension.value[x]
      Definition

      The Encounter during which this resource was created or to which the creation is tightly associated.

      ShortEncounter
      Comments

      This will typically be the encounter the event occurred within, but some activities may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter (e.g. completing the administrative registration after the encounter).

      Control0..1
      This element is affected by the following invariants: ele-1
      TypeReference(Encounter)
      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))