STU 3 Candidate

This page is part of the FHIR Specification (v1.4.0: STU 3 Ballot 3). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3 R2

Oid.profile.json

Raw JSON (canonical form)

StructureDefinition for oid

{
  "resourceType": "StructureDefinition",
  "id": "oid",
  "meta": {
    "lastUpdated": "2016-03-31T08:01:25.570+11:00"
  },
  "text": {
    "status": "generated",
    "div": "<div>!-- Snipped for Brevity --></div>"
  },
  "url": "http://hl7.org/fhir/StructureDefinition/oid",
  "name": "oid",
  "status": "draft",
  "publisher": "HL7 FHIR Standard",
  "contact": [
    {
      "telecom": [
        {
          "system": "other",
          "value": "http://hl7.org/fhir"
        }
      ]
    }
  ],
  "date": "2016-03-31T08:01:25+11:00",
  "description": "Base StructureDefinition for oid type: An oid represented as a URI",
  "fhirVersion": "1.4.0",
  "kind": "datatype",
  "abstract": false,
  "baseType": "uri",
  "baseDefinition": "http://hl7.org/fhir/StructureDefinition/uri",
  "derivation": "specialization",
  "snapshot": {
    "element": [
      {
        "path": "uri",
        "short": "Primitive Type oid",
        "definition": "An oid represented as a URI",
        "comments": "RFC 3001. See also ISO/IEC 8824:1990 €",
        "min": 0,
        "max": "*",
        "base": {
          "path": "uri",
          "min": 0,
          "max": "*"
        },
        "type": [
          {
            "code": "Element"
          }
        ]
      },
      {
        "path": "uri.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 resource. 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": "uri.extension",
          "min": 0,
          "max": "*"
        },
        "type": [
          {
            "code": "Extension"
          }
        ]
      },
      {
        "path": "uri.value",
        "representation": [
          "xmlAttr"
        ],
        "short": "Primitive value for oid",
        "definition": "Primitive value for oid",
        "min": 0,
        "max": "1",
        "base": {
          "path": "uri.value",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "fhir_comments": [
              "Note: primitive values do not have an assigned type\r\n      e.g. this is compiler magic\r\n      XML and JSON types provided by extension"
            ],
            "extension": [
              {
                "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-regex",
                "valueString": "urn:oid:(0|[1-9][0-9]*)(\\.(0|[1-9][0-9]*))*"
              }
            ],
            "_code": {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-json-type",
                  "valueString": "string"
                },
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-xml-type",
                  "valueString": "xs:anyURI+"
                }
              ]
            }
          }
        ]
      }
    ]
  },
  "differential": {
    "element": [
      {
        "path": "uri",
        "short": "Primitive Type oid",
        "definition": "An oid represented as a URI",
        "comments": "RFC 3001. See also ISO/IEC 8824:1990 €",
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "Element"
          }
        ]
      },
      {
        "path": "uri.value",
        "representation": [
          "xmlAttr"
        ],
        "short": "Primitive value for oid",
        "definition": "Primitive value for oid",
        "min": 0,
        "max": "1",
        "type": [
          {
            "fhir_comments": [
              "Note: primitive values do not have an assigned type\r\n      e.g. this is compiler magic\r\n      XML and JSON types provided by extension"
            ],
            "extension": [
              {
                "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-regex",
                "valueString": "urn:oid:(0|[1-9][0-9]*)(\\.(0|[1-9][0-9]*))*"
              }
            ],
            "_code": {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-json-type",
                  "valueString": "string"
                },
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-xml-type",
                  "valueString": "xs:anyURI+"
                }
              ]
            }
          }
        ]
      }
    ]
  }
}

Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.