JASPEHR(the JApanese Standard Platform for EHRs) 実装ガイド
1.0.0 - draft

JASPEHR(the JApanese Standard Platform for EHRs) 実装ガイド - Local Development build (v1.0.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Extension: JSP_QResponse_Submission - Detailed Descriptions

Page standards status: Trial-use Maturity Level: 4

Definitions for the jsp-qresponse-submission extension.

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

0. Extension
Definition

提出データに添付するリソースをFHIR Query形式で条件とともに指定する


Optional Extension Element - found in all resources.

Short提出データ定義Optional Extensions Element
Comments

CodeSystem(http://jaspehr.jp/fhir/CodeSystem/JSP_QResponse_Submission_CS)からattachmentを使用して、valueExpressionにて添付するリソースを定義する。

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())
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..01
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
4. 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 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
    Is Modifierfalse
    XML FormatIn the XML format, this property is represented as an attribute.
    Summaryfalse
    Fixed Valuehttp://jaspehr.jp/fhir/StructureDefinition/JSP_QResponse_Submission
    8. 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
    Control10..1
    TypeExpression, 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, boolean, 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()))
    SlicingThis element introduces a set of slices on Extension.value[x]. The slices areUnordered and Closed, and can be differentiated using the following discriminators:
    • type @ $this
    • 10. Extension.value[x]:valueExpression
      Slice NamevalueExpression
      Definition

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

      ShortValue of extension
      Control10..1
      TypeExpression, 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, boolean, 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()))
      12. Extension.value[x]:valueExpression.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..01
      Typestring
      Is Modifierfalse
      XML FormatIn the XML format, this property is represented as an attribute.
      Summaryfalse
      14. Extension.value[x]:valueExpression.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.value[x].extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
      • value @ url
      • 16. Extension.value[x]:valueExpression.description
        Definition

        A brief, natural language description of the condition that effectively communicates the intended semantics.

        Shortリソースタイプを指定Natural language description of the condition
        Control10..1
        BindingThe codes SHALL be taken from For codes, see JSP Resource Types ValueSet
        (required to http://jaspehr.jp/fhir/StructureDefinition/JSP_Resource_Types_VS)
        Typestring
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        18. Extension.value[x]:valueExpression.name
        Definition

        A short name assigned to the expression to allow for multiple reuse of the expression in the context where it is defined.

        ShortShort name assigned to expression for reuse
        Control0..01
        Typeid
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        20. Extension.value[x]:valueExpression.language
        Definition

        The media type of the language for the expression.

        Short「application/x-fhir-query」固定text/cql | text/fhirpath | application/x-fhir-query | etc.
        Control1..1
        BindingUnless not suitable, these codes SHALL be taken from ExpressionLanguagehttp://hl7.org/fhir/ValueSet/expression-language
        (extensible to http://hl7.org/fhir/ValueSet/expression-language)

        The media type of the expression language.

        Additional BindingsPurpose
        http://www.rfc-editor.org/bcp/bcp13.txtMax Binding
        Typecode
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        Pattern Valueapplication/x-fhir-query
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        22. Extension.value[x]:valueExpression.expression
        Definition

        An expression in the specified language that returns a value.

        Short添付するリソースとその検索条件をfhir-queryで指定Expression in specified language
        Control10..1
        Typestring
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        24. Extension.value[x]:valueExpression.reference
        Definition

        A URI that defines where the expression is found.

        ShortWhere the expression is found
        Comments

        If both a reference and an expression is found, the reference SHALL point to the same expression.

        Control0..01
        Typeuri
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        Invariantsele-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 found here

        0. Extension
        Definition

        提出データに添付するリソースをFHIR Query形式で条件とともに指定する

        Short提出データ定義
        Comments

        CodeSystem(http://jaspehr.jp/fhir/CodeSystem/JSP_QResponse_Submission_CS)からattachmentを使用して、valueExpressionにて添付するリソースを定義する。

        2. Extension.id
        Control0..0
        4. Extension.extension
        Control0..0
        6. Extension.url
        Fixed Valuehttp://jaspehr.jp/fhir/StructureDefinition/JSP_QResponse_Submission
        8. Extension.value[x]
        Control1..?
        TypeExpression, 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, boolean, Signature, unsignedInt, time
        [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
        SlicingThis element introduces a set of slices on Extension.value[x]. The slices areUnordered and Open, and can be differentiated using the following discriminators:
        • type @ $this
        • 10. Extension.valueExpression
          Control1..1
          12. Extension.valueExpression.id
          Control0..0
          14. Extension.valueExpression.extension
          Control0..0
          16. Extension.valueExpression.description
          Shortリソースタイプを指定
          Control1..?
          BindingThe codes SHALL be taken from JSP Resource Types ValueSet
          (required to http://jaspehr.jp/fhir/StructureDefinition/JSP_Resource_Types_VS)
          18. Extension.valueExpression.name
          Control0..0
          20. Extension.valueExpression.language
          Short「application/x-fhir-query」固定
          Pattern Valueapplication/x-fhir-query
          22. Extension.valueExpression.expression
          Short添付するリソースとその検索条件をfhir-queryで指定
          Control1..?
          24. Extension.valueExpression.reference
          Control0..0

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

          0. Extension
          Definition

          提出データに添付するリソースをFHIR Query形式で条件とともに指定する

          Short提出データ定義
          Comments

          CodeSystem(http://jaspehr.jp/fhir/CodeSystem/JSP_QResponse_Submission_CS)からattachmentを使用して、valueExpressionにて添付するリソースを定義する。

          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..0
          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 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
            Is Modifierfalse
            XML FormatIn the XML format, this property is represented as an attribute.
            Summaryfalse
            Fixed Valuehttp://jaspehr.jp/fhir/StructureDefinition/JSP_QResponse_Submission
            8. 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
            Control1..1
            TypeExpression
            [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()))
            SlicingThis element introduces a set of slices on Extension.value[x]. The slices areUnordered and Closed, and can be differentiated using the following discriminators:
            • type @ $this
            • 10. Extension.value[x]:valueExpression
              Slice NamevalueExpression
              Definition

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

              ShortValue of extension
              Control1..1
              TypeExpression
              [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()))
              12. Extension.value[x]:valueExpression.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..0
              Typestring
              Is Modifierfalse
              XML FormatIn the XML format, this property is represented as an attribute.
              Summaryfalse
              14. Extension.value[x]:valueExpression.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.value[x].extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
              • value @ url
              • 16. Extension.value[x]:valueExpression.description
                Definition

                A brief, natural language description of the condition that effectively communicates the intended semantics.

                Shortリソースタイプを指定
                Control1..1
                BindingThe codes SHALL be taken from JSP Resource Types ValueSet
                (required to http://jaspehr.jp/fhir/StructureDefinition/JSP_Resource_Types_VS)
                Typestring
                Is Modifierfalse
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                Summarytrue
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                18. Extension.value[x]:valueExpression.name
                Definition

                A short name assigned to the expression to allow for multiple reuse of the expression in the context where it is defined.

                ShortShort name assigned to expression for reuse
                Control0..0
                Typeid
                Is Modifierfalse
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                Summarytrue
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                20. Extension.value[x]:valueExpression.language
                Definition

                The media type of the language for the expression.

                Short「application/x-fhir-query」固定
                Control1..1
                BindingUnless not suitable, these codes SHALL be taken from ExpressionLanguage
                (extensible to http://hl7.org/fhir/ValueSet/expression-language)

                The media type of the expression language.

                Additional BindingsPurpose
                http://www.rfc-editor.org/bcp/bcp13.txtMax Binding
                Typecode
                Is Modifierfalse
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                Summarytrue
                Pattern Valueapplication/x-fhir-query
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                22. Extension.value[x]:valueExpression.expression
                Definition

                An expression in the specified language that returns a value.

                Short添付するリソースとその検索条件をfhir-queryで指定
                Control1..1
                Typestring
                Is Modifierfalse
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                Summarytrue
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                24. Extension.value[x]:valueExpression.reference
                Definition

                A URI that defines where the expression is found.

                ShortWhere the expression is found
                Comments

                If both a reference and an expression is found, the reference SHALL point to the same expression.

                Control0..0
                Typeuri
                Is Modifierfalse
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                Summarytrue
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))