Site Tools


4smicroservices:observationservice:conformance

This is an old revision of the document!


Observation Service FHIR API (conformance statement)

{
  "resourceType": "Conformance",
  "publisher": "Not provided",
  "date": "2017-03-17T10:55:50+00:00",
  "kind": "instance",
  "software": {
    "name": "HAPI FHIR Server",
    "version": "2.1"
  },
  "implementation": {
    "description": "Example Server"
  },
  "fhirVersion": "1.0.2",
  "acceptUnknown": "extensions",
  "format": [
    "application/xml+fhir",
    "application/json+fhir"
  ],
  "rest": [
    {
      "mode": "server",
      "resource": [
        {
          "extension": [
            {
              "url": "http://hl7api.sourceforge.net/hapi-fhir/res/extdefs.html#resourceCount",
              "valueDecimal": 5
            }
          ],
          "type": "Observation",
          "profile": {
            "reference": "http://hl7.org/fhir/profiles/Observation"
          },
          "interaction": [
            {
              "code": "read"
            },
            {
              "code": "vread"
            },
            {
              "code": "update"
            },
            {
              "code": "delete"
            },
            {
              "code": "history-instance"
            },
            {
              "code": "history-type"
            },
            {
              "code": "create"
            },
            {
              "code": "search-type"
            }
          ],
          "conditionalCreate": true,
          "conditionalUpdate": true,
          "conditionalDelete": "multiple",
          "searchInclude": [
            "*",
            "Observation:device",
            "Observation:encounter",
            "Observation:patient",
            "Observation:performer",
            "Observation:related-target",
            "Observation:specimen",
            "Observation:subject"
          ],
          "searchParam": [
            {
              "name": "_content",
              "type": "string",
              "documentation": "Search the contents of the resource's data using a fulltext search"
            },
            {
              "name": "_has",
              "type": "string",
              "documentation": "Return resources linked to by the given target"
            },
            {
              "name": "_id",
              "type": "string",
              "documentation": "The resource identity"
            },
            {
              "name": "_language",
              "type": "string",
              "documentation": "The resource language"
            },
            {
              "name": "_lastUpdated",
              "type": "date",
              "documentation": "Only return resources which were last updated as specified by the given range"
            },
            {
              "name": "_profile",
              "type": "uri",
              "documentation": "Search for resources which have the given profile"
            },
            {
              "name": "_security",
              "type": "token",
              "documentation": "Search for resources which have the given security labels"
            },
            {
              "name": "_tag",
              "type": "token",
              "documentation": "Search for resources which have the given tag"
            },
            {
              "name": "_text",
              "type": "string",
              "documentation": "Search the contents of the resource's narrative using a fulltext search"
            },
            {
              "name": "category",
              "type": "token",
              "documentation": "The classification of the type of observation"
            },
            {
              "name": "code",
              "type": "token",
              "documentation": "The code of the observation type"
            },
            {
              "name": "code-value-concept",
              "type": "composite",
              "documentation": "Both code and one of the value parameters"
            },
            {
              "name": "code-value-date",
              "type": "composite",
              "documentation": "Both code and one of the value parameters"
            },
            {
              "name": "code-value-quantity",
              "type": "composite",
              "documentation": "Both code and one of the value parameters"
            },
            {
              "name": "code-value-string",
              "type": "composite",
              "documentation": "Both code and one of the value parameters"
            },
            {
              "name": "component-code",
              "type": "token",
              "documentation": "The component code of the observation type"
            },
            {
              "name": "component-code-component-value-concept",
              "type": "composite",
              "documentation": "Both component code and one of the component value parameters"
            },
            {
              "name": "component-code-component-value-quantity",
              "type": "composite",
              "documentation": "Both component code and one of the component value parameters"
            },
            {
              "name": "component-code-component-value-string",
              "type": "composite",
              "documentation": "Both component code and one of the component value parameters"
            },
            {
              "name": "component-data-absent-reason",
              "type": "token",
              "documentation": "The reason why the expected value in the element Observation.component.value[x] is missing."
            },
            {
              "name": "component-value-concept",
              "type": "token",
              "documentation": "The value of the component observation, if the value is a CodeableConcept"
            },
            {
              "name": "component-value-quantity",
              "type": "quantity",
              "documentation": "The value of the component observation, if the value is a Quantity, or a SampledData (just search on the bounds of the values in sampled data)"
            },
            {
              "name": "component-value-string",
              "type": "string",
              "documentation": "The value of the component observation, if the value is a string, and also searches in CodeableConcept.text"
            },
            {
              "name": "data-absent-reason",
              "type": "token",
              "documentation": "The reason why the expected value in the element Observation.value[x] is missing."
            },
            {
              "name": "date",
              "type": "date",
              "documentation": "Obtained date/time. If the obtained element is a period, a date that falls in the period"
            },
            {
              "name": "device",
              "type": "reference",
              "documentation": "The Device that generated the observation data.",
              "chain": [
                "*"
              ]
            },
            {
              "name": "encounter",
              "type": "reference",
              "documentation": "Healthcare event related to the observation",
              "chain": [
                "*"
              ]
            },
            {
              "name": "identifier",
              "type": "token",
              "documentation": "The unique id for a particular observation"
            },
            {
              "name": "patient",
              "type": "reference",
              "documentation": "The subject that the observation is about (if patient)",
              "target": [
                "Patient"
              ],
              "chain": [
                "*",
                "_id",
                "_language",
                "active",
                "address",
                "address-city",
                "address-country",
                "address-postalcode",
                "address-state",
                "address-use",
                "animal-breed",
                "animal-species",
                "birthdate",
                "careprovider",
                "deathdate",
                "deceased",
                "email",
                "family",
                "gender",
                "given",
                "identifier",
                "language",
                "link",
                "name",
                "organization",
                "phone",
                "phonetic",
                "telecom"
              ]
            },
            {
              "name": "performer",
              "type": "reference",
              "documentation": "Who performed the observation",
              "chain": [
                "*"
              ]
            },
            {
              "name": "related-target",
              "type": "reference",
              "chain": [
                "*"
              ]
            },
            {
              "name": "related-target-related-type",
              "type": "composite",
              "documentation": "Related Observations - search on related-type and related-target together"
            },
            {
              "name": "related-type",
              "type": "token"
            },
            {
              "name": "specimen",
              "type": "reference",
              "chain": [
                "*"
              ]
            },
            {
              "name": "status",
              "type": "token",
              "documentation": "The status of the observation"
            },
            {
              "name": "subject",
              "type": "reference",
              "documentation": "The subject that the observation is about",
              "chain": [
                "*"
              ]
            },
            {
              "name": "value-concept",
              "type": "token",
              "documentation": "The value of the observation, if the value is a CodeableConcept"
            },
            {
              "name": "value-date",
              "type": "date",
              "documentation": "The value of the observation, if the value is a date or period of time"
            },
            {
              "name": "value-quantity",
              "type": "quantity",
              "documentation": "The value of the observation, if the value is a Quantity, or a SampledData (just search on the bounds of the values in sampled data)"
            },
            {
              "name": "value-string",
              "type": "string",
              "documentation": "The value of the observation, if the value is a string, and also searches in CodeableConcept.text"
            }
          ]
        },
        {
          "type": "OperationDefinition",
          "profile": {
            "reference": "http://hl7.org/fhir/profiles/OperationDefinition"
          },
          "interaction": [
            {
              "code": "read"
            }
          ]
        },
        {
          "type": "StructureDefinition",
          "profile": {
            "reference": "http://hl7.org/fhir/profiles/StructureDefinition"
          },
          "interaction": [
            {
              "code": "read"
            },
            {
              "code": "search-type"
            }
          ]
        }
      ],
      "operation": [
        {
          "name": "validate",
          "definition": {
            "reference": "OperationDefinition/Observation-i-validate"
          }
        },
        {
          "name": "validate",
          "definition": {
            "reference": "OperationDefinition/Observation--validate"
          }
        },
        {
          "name": "meta",
          "definition": {
            "reference": "OperationDefinition/Observation--meta"
          }
        },
        {
          "name": "meta",
          "definition": {
            "reference": "OperationDefinition/Observation-i-meta"
          }
        },
        {
          "name": "meta-add",
          "definition": {
            "reference": "OperationDefinition/Observation-i-meta-add"
          }
        },
        {
          "name": "meta-delete",
          "definition": {
            "reference": "OperationDefinition/Observation-i-meta-delete"
          }
        }
      ]
    }
  ]
}
4smicroservices/observationservice/conformance.1489748332.txt.gz · Last modified: 2018/12/12 13:31 (external edit)