fhir-schemas/fhir.schema.json/Identifier.schema.json

Schemas for Fast Healthcare Interoperability Resources.

{
  "schema": "http://json-schema.org/draft-04/schema#",
  "$id": "http://hl7.org/fhir/json-schema/Identifier",
  "$ref": "#/definitions/Identifier",
  "description": "see http://hl7.org/fhir/json.html#schema for information about the FHIR Json Schemas",
  "definitions": {
    "Identifier": {
      "allOf": [
        {
          "$ref": "Element#/definitions/Element"
        },
        {
          "description": "A technical identifier - identifies some entity uniquely and unambiguously.",
          "properties": {
            "use": {
              "description": "The purpose of this identifier.",
              "enum": [
                "usual",
                "official",
                "temp",
                "secondary"
              ],
              "type": "string"
            },
            "_use": {
              "description": "Extensions for use",
              "$ref": "http://hl7.org/fhir/json-schema/Element#/definitions/Element"
            },
            "type": {
              "description": "A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.",
              "$ref": "http://hl7.org/fhir/json-schema/CodeableConcept#/definitions/CodeableConcept"
            },
            "system": {
              "description": "Establishes the namespace for the value - that is, a URL that describes a set values that are unique.",
              "type": "string"
            },
            "_system": {
              "description": "Extensions for system",
              "$ref": "http://hl7.org/fhir/json-schema/Element#/definitions/Element"
            },
            "value": {
              "description": "The portion of the identifier typically relevant to the user and which is unique within the context of the system.",
              "type": "string"
            },
            "_value": {
              "description": "Extensions for value",
              "$ref": "http://hl7.org/fhir/json-schema/Element#/definitions/Element"
            },
            "period": {
              "description": "Time period during which identifier is/was valid for use.",
              "$ref": "http://hl7.org/fhir/json-schema/Period#/definitions/Period"
            },
            "assigner": {
              "description": "Organization that issued/manages the identifier.",
              "$ref": "http://hl7.org/fhir/json-schema/Reference#/definitions/Reference"
            }
          }
        }
      ]
    }
  }
}