schemas.Reference.schema.json Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of fhirlib Show documentation

A scala ser/de library for working with FHIR data

There is a newer version: 0.10.1

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "id": "http://hl7.org/fhir/json-schema/Reference",
  "$ref": "#/definitions/Reference",
  "description": "see http://hl7.org/fhir/json.html#schema for information about the FHIR Json Schemas",
  "definitions": {
    "Reference": {
      "allOf": [
        {
          "$ref": "Element#/definitions/Element"
        },
        {
          "description": "A reference from one resource to another.",
          "properties": {
            "reference": {
              "description": "A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with \u0027#\u0027) refer to contained resources.",
              "type": "string"
            },
            "_reference": {
              "description": "Extensions for reference",
              "$ref": "Element.schema.json#/definitions/Element"
            },
            "identifier": {
              "description": "An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.",
              "$ref": "Identifier.schema.json#/definitions/Identifier"
            },
            "display": {
              "description": "Plain text narrative that identifies the resource in addition to the resource reference.",
              "type": "string"
            },
            "_display": {
              "description": "Extensions for display",
              "$ref": "Element.schema.json#/definitions/Element"
            }
          }
        }
      ]
    }
  }
}