This page is part of the Structured Data Capture FHIR IG (v1.6: STU 2 Ballot 1) based on FHIR v1.6.0. . For a full list of available versions, see the Directory of published versions

This is a pre-release of a future version of SDC (expected to be STU 2). The current version is STU 2.
For a full list of available versions, see the Directory of published versions .

9.2.9 Extension: Endpoint - JSON Profile

JSON representation of the sdc-questionnaire-endpoint Extension

{
  "resourceType" : "StructureDefinition",
  "id" : "sdc-questionnaire-endpoint",
  "url" : "http://hl7.org/fhir/us/sdc/StructureDefinition/sdc-questionnaire-endpoint",
  "name" : "Endpoint",
  "display" : "Endpoint",
  "status" : "draft",
  "publisher" : "Health Level Seven International (Orders and Observations - Structured Data Capture)",
  "contact" : [
    {
      "telecom" : [
        {
          "system" : "other",
          "value" : "http://wiki.siframework.org/Structured+Data+Capture+Initiative"
        }
      }
    }
  },
  "date" : "2014-04-21",
  "description" : "The base URL for the server to which questionnaire response associated with this questionnaire should be submitted.",
  "fhirVersion" : "1.6.0",
  "mapping" : [
    {
      "identity" : "rim",
      "uri" : "http://hl7.org/v3",
      "name" : "RIM Mapping"
    }
  },
  "kind" : "complex-type",
  "abstract" : false,
  "contextType" : "resource",
  "context" : [
    "Questionnaire"
  },
  "type" : "Extension",
  "baseDefinition" : "http://hl7.org/fhir/StructureDefinition/Extension",
  "derivation" : "constraint",
  "snapshot" : {
    "element" : [
      {
        "id" : "Extension:endpoint",
        "path" : "Extension",
        "name" : "endpoint",
        "short" : "Extension",
        "definition" : "The base URL for the server to which questionnaire response associated with this questionnaire should be submitted.",
        "comments" : "Indicates that the form has been designed with an expectation that it will be submitted to the specified URI.  If multiple endpoints are specified, expectation is that answers are submitted to all endpoints.

If no end-point is specified, then the form is not exclusively designed to be submitted to a specific site.  If and where the form needs to be submitted or how the form should be internally processed must be inferred from external context or system business rules.",
        "min" : 0,
        "max" : "*",
        "base" : {
          "path" : "Extension",
          "min" : 0,
          "max" : "*"
        },
        "condition" : [
          "ele-1"
        },
        "constraint" : [
          {
            "key" : "ele-1",
            "severity" : "error",
            "human" : "All FHIR elements must have a @value or children",
            "expression" : "children().count() > id.count()",
            "xpath" : "@value|f:*|h:div"
          },
          {
            "key" : "ext-1",
            "severity" : "error",
            "human" : "Must have either extensions or value[x], not both",
            "expression" : "extension.exists() != value.exists()",
            "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])"
          }
        },
        "isModifier" : false
      },
      {
        "id" : "Extension:endpoint.id",
        "path" : "Extension.id",
        "representation" : [
          "xmlAttr"
        },
        "short" : "xml:id (or equivalent in JSON)",
        "definition" : "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
        "min" : 0,
        "max" : "1",
        "base" : {
          "path" : "Element.id",
          "min" : 0,
          "max" : "*"
        },
        "type" : [
          {
            "code" : "string"
          }
        },
        "mapping" : [
          {
            "identity" : "rim",
            "map" : "n/a"
          }
        }
      },
      {
        "id" : "Extension:endpoint.extension",
        "path" : "Extension.extension",
        "short" : "Additional Content defined by implementations",
        "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.",
        "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.",
        "alias" : [
          "extensions",
          "user content"
        },
        "min" : 0,
        "max" : "*",
        "base" : {
          "path" : "Element.extension",
          "min" : 0,
          "max" : "*"
        },
        "type" : [
          {
            "code" : "Extension"
          }
        },
        "mapping" : [
          {
            "identity" : "rim",
            "map" : "n/a"
          }
        }
      },
      {
        "id" : "Extension:endpoint.url",
        "path" : "Extension.url",
        "representation" : [
          "xmlAttr"
        },
        "short" : "identifies the meaning of the extension",
        "definition" : "Source of the definition for the extension code - a logical name or a URL.",
        "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.",
        "min" : 1,
        "max" : "1",
        "base" : {
          "path" : "Extension.url",
          "min" : 1,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "uri"
          }
        },
        "fixedUri" : "http://hl7.org/fhir/us/sdc/StructureDefinition/sdc-questionnaire-endpoint",
        "mapping" : [
          {
            "identity" : "rim",
            "map" : "N/A"
          }
        }
      },
      {
        "id" : "Extension:endpoint.valueUri",
        "path" : "Extension.valueUri",
        "short" : "Value of extension",
        "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).",
        "min" : 0,
        "max" : "1",
        "base" : {
          "path" : "Extension.value[x]",
          "min" : 0,
          "max" : "1"
        },
        "type" : [
          {
            "code" : "uri"
          }
        },
        "mapping" : [
          {
            "identity" : "rim",
            "map" : "N/A"
          }
        }
      }
    }
  },
  "differential" : {
    "element" : [
      {
        "id" : "Extension:endpoint",
        "path" : "Extension",
        "name" : "endpoint",
        "definition" : "The base URL for the server to which questionnaire response associated with this questionnaire should be submitted.",
        "comments" : "Indicates that the form has been designed with an expectation that it will be submitted to the specified URI.  If multiple endpoints are specified, expectation is that answers are submitted to all endpoints.

If no end-point is specified, then the form is not exclusively designed to be submitted to a specific site.  If and where the form needs to be submitted or how the form should be internally processed must be inferred from external context or system business rules.",
        "min" : 0,
        "max" : "*",
        "isModifier" : false
      },
      {
        "id" : "Extension:endpoint.url",
        "path" : "Extension.url",
        "fixedUri" : "http://hl7.org/fhir/us/sdc/StructureDefinition/sdc-questionnaire-endpoint"
      },
      {
        "id" : "Extension:endpoint.value[x]",
        "path" : "Extension.value[x]",
        "type" : [
          {
            "code" : "uri"
          }
        }
      }
    }
  }
}