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

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

Extension: ExtensionServiceRequest_PatientInstruction - Detailed Descriptions

Page standards status: Trial-use Maturity Level: 0

Definitions for the ext-R5-ServiceRequest.patientInstruction extension.

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

0. Extension
Definition

R5: ServiceRequest.patientInstruction (new:BackboneElement)


Optional Extension Element - found in all resources.

ShortR5: Patient or consumer-oriented instructions (new)Optional Extensions Element
Comments

Element ServiceRequest.patientInstruction has a context of ProcedureRequest based on following the parent source element upwards and mapping to ProcedureRequest. Element ServiceRequest.patientInstruction has a context of ReferralRequest based on following the parent source element upwards and mapping to ReferralRequest. Element ServiceRequest.patientInstruction has no mapping targets in FHIR STU3. 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() | (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()))
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. 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..*
TypeExtension
Alternate Namesextensions, user content
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:instruction
    Slice Nameinstruction
    Definition

    R5: ServiceRequest.patientInstruction.instruction[x] (new:markdown, Reference(DocumentReference))

    ShortR5: Patient or consumer-oriented instructions (new)Additional Content defined by implementations
    Comments

    Element ServiceRequest.patientInstruction.instruction[x] is part of an existing definition because parent element ServiceRequest.patientInstruction requires a cross-version extension. Element ServiceRequest.patientInstruction.instruction[x] has a context of ProcedureRequest based on following the parent source element upwards and mapping to ProcedureRequest. Element ServiceRequest.patientInstruction.instruction[x] has a context of ReferralRequest based on following the parent source element upwards and mapping to ReferralRequest. Element ServiceRequest.patientInstruction.instruction[x] has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

    Control0..1*
    TypeExtension
    Requirements

    Element ServiceRequest.patientInstruction.instruction[x] is part of an existing definition because parent element ServiceRequest.patientInstruction requires a cross-version extension. Element ServiceRequest.patientInstruction.instruction[x] has a context of ProcedureRequest based on following the parent source element upwards and mapping to ProcedureRequest. Element ServiceRequest.patientInstruction.instruction[x] has a context of ReferralRequest based on following the parent source element upwards and mapping to ReferralRequest. Element ServiceRequest.patientInstruction.instruction[x] has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

    6. Extension.extension:instruction.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 Valueinstruction
    8. Extension.extension:instruction.value[x]
    Definition

    Instructions in terms that are understood by the patient or consumer.


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

    ShortPatient or consumer-oriented instructionsValue of extension
    Control0..1
    TypeChoice of: markdown, Reference(Cross-version Profile for R5.DocumentReference for use in FHIR STU3, Media), date, dateTime, Meta, code, string, Address, Attachment, integer, oid, Count, instant, ContactPoint, HumanName, Money, Identifier, Coding, 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]
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    10. 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 Valuehttp://hl7.org/fhir/5.0/StructureDefinition/extension-ServiceRequest.patientInstruction
    12. Extension.value[x]
    Definition

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

    ShortValue of extension
    Control0..01
    TypeChoice of: base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, Meta
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension

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

    0. Extension
    Definition

    R5: ServiceRequest.patientInstruction (new:BackboneElement)

    ShortR5: Patient or consumer-oriented instructions (new)
    Comments

    Element ServiceRequest.patientInstruction has a context of ProcedureRequest based on following the parent source element upwards and mapping to ProcedureRequest. Element ServiceRequest.patientInstruction has a context of ReferralRequest based on following the parent source element upwards and mapping to ReferralRequest. Element ServiceRequest.patientInstruction has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

    Control0..*
    Is Modifierfalse
    2. Extension.extension
    Control0..*
    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:instruction
      Slice Nameinstruction
      Definition

      R5: ServiceRequest.patientInstruction.instruction[x] (new:markdown, Reference(DocumentReference))

      ShortR5: Patient or consumer-oriented instructions (new)
      Comments

      Element ServiceRequest.patientInstruction.instruction[x] is part of an existing definition because parent element ServiceRequest.patientInstruction requires a cross-version extension. Element ServiceRequest.patientInstruction.instruction[x] has a context of ProcedureRequest based on following the parent source element upwards and mapping to ProcedureRequest. Element ServiceRequest.patientInstruction.instruction[x] has a context of ReferralRequest based on following the parent source element upwards and mapping to ReferralRequest. Element ServiceRequest.patientInstruction.instruction[x] has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

      Control0..1
      Requirements

      Element ServiceRequest.patientInstruction.instruction[x] is part of an existing definition because parent element ServiceRequest.patientInstruction requires a cross-version extension. Element ServiceRequest.patientInstruction.instruction[x] has a context of ProcedureRequest based on following the parent source element upwards and mapping to ProcedureRequest. Element ServiceRequest.patientInstruction.instruction[x] has a context of ReferralRequest based on following the parent source element upwards and mapping to ReferralRequest. Element ServiceRequest.patientInstruction.instruction[x] has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

      6. Extension.extension:instruction.url
      Control1..1
      Fixed Valueinstruction
      8. Extension.extension:instruction.value[x]
      Definition

      Instructions in terms that are understood by the patient or consumer.

      ShortPatient or consumer-oriented instructions
      Control0..1
      TypeChoice of: markdown, Reference(Cross-version Profile for R5.DocumentReference for use in FHIR STU3, Media)
      [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.url
      Control1..1
      Fixed Valuehttp://hl7.org/fhir/5.0/StructureDefinition/extension-ServiceRequest.patientInstruction
      12. Extension.value[x]
      Control0..0

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

      0. Extension
      Definition

      R5: ServiceRequest.patientInstruction (new:BackboneElement)

      ShortR5: Patient or consumer-oriented instructions (new)
      Comments

      Element ServiceRequest.patientInstruction has a context of ProcedureRequest based on following the parent source element upwards and mapping to ProcedureRequest. Element ServiceRequest.patientInstruction has a context of ReferralRequest based on following the parent source element upwards and mapping to ReferralRequest. Element ServiceRequest.patientInstruction has no mapping targets in FHIR STU3. 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() | (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..*
      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.extension:instruction
        Slice Nameinstruction
        Definition

        R5: ServiceRequest.patientInstruction.instruction[x] (new:markdown, Reference(DocumentReference))

        ShortR5: Patient or consumer-oriented instructions (new)
        Comments

        Element ServiceRequest.patientInstruction.instruction[x] is part of an existing definition because parent element ServiceRequest.patientInstruction requires a cross-version extension. Element ServiceRequest.patientInstruction.instruction[x] has a context of ProcedureRequest based on following the parent source element upwards and mapping to ProcedureRequest. Element ServiceRequest.patientInstruction.instruction[x] has a context of ReferralRequest based on following the parent source element upwards and mapping to ReferralRequest. Element ServiceRequest.patientInstruction.instruction[x] has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

        Control0..1
        TypeExtension
        Requirements

        Element ServiceRequest.patientInstruction.instruction[x] is part of an existing definition because parent element ServiceRequest.patientInstruction requires a cross-version extension. Element ServiceRequest.patientInstruction.instruction[x] has a context of ProcedureRequest based on following the parent source element upwards and mapping to ProcedureRequest. Element ServiceRequest.patientInstruction.instruction[x] has a context of ReferralRequest based on following the parent source element upwards and mapping to ReferralRequest. Element ServiceRequest.patientInstruction.instruction[x] has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

        8. Extension.extension:instruction.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.
        10. Extension.extension:instruction.extension
        Definition

        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.

        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
        Alternate Namesextensions, user content
        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:instruction.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 Valueinstruction
          14. Extension.extension:instruction.value[x]
          Definition

          Instructions in terms that are understood by the patient or consumer.

          ShortPatient or consumer-oriented instructions
          Control0..1
          TypeChoice of: markdown, Reference(Cross-version Profile for R5.DocumentReference for use in FHIR STU3, Media)
          [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.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 Valuehttp://hl7.org/fhir/5.0/StructureDefinition/extension-ServiceRequest.patientInstruction
          18. Extension.value[x]
          Definition

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

          ShortValue of extension
          Control0..0
          TypeChoice of: base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, Meta
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension