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

Extension-codesystem-oid.json

Raw JSON (canonical form)

OID assigned to the value set or code system

{
  "resourceType": "StructureDefinition",
  "id": "codesystem-oid",
  "url": "http://hl7.org/fhir/StructureDefinition/codesystem-oid",
  "name": "OID assigned to the value set or code system",
  "status": "draft",
  "publisher": "HL7",
  "date": "2016-03-31T08:01:25+11:00",
  "description": "The OID assigned the same object as the URI points to. Examples include OIDs assigned to code systems like SNOMED CT (urn:oid:2.16.840.1.113883..6.96) or LOINC (urn:oid:2.16.840.1.113883.6.1), value sets like AdministrativeGender (urn:oid:2.16.840.1.113883.11.1), identification systems like SSN (urn:oid:2.16.840.1.113883.4.1) etc.",
  "fhirVersion": "1.4.0",
  "kind": "datatype",
  "abstract": false,
  "contextType": "resource",
  "context": [
    "CodeSystem"
  ],
  "baseType": "Extension",
  "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension",
  "derivation": "constraint",
  "snapshot": {
    "element": [
      {
        "path": "Extension",
        "short": "OID assigned to the value set or code system",
        "definition": "The OID assigned the same object as the URI points to. Examples include OIDs assigned to code systems like SNOMED CT (urn:oid:2.16.840.1.113883..6.96) or LOINC (urn:oid:2.16.840.1.113883.6.1), value sets like AdministrativeGender (urn:oid:2.16.840.1.113883.11.1), identification systems like SSN (urn:oid:2.16.840.1.113883.4.1) etc.",
        "min": 0,
        "max": "1",
        "base": {
          "path": "Extension",
          "min": 0,
          "max": "*"
        },
        "type": [
          {
            "code": "Extension"
          }
        ],
        "isModifier": false
      },
      {
        "path": "Extension.id",
        "representation": [
          "xmlAttr"
        ],
        "short": "xml:id (or equivalent in JSON)",
        "definition": "unique id for the element within a resource (for internal references).",
        "min": 0,
        "max": "1",
        "base": {
          "path": "Element.id",
          "min": 0,
          "max": "*"
        },
        "type": [
          {
            "code": "id"
          }
        ],
        "mapping": [
          {
            "identity": "rim",
            "map": "n/a"
          }
        ]
      },
      {
        "path": "Extension.extension",
        "name": "extension",
        "short": "Extension",
        "definition": "An Extension",
        "min": 0,
        "max": "0",
        "base": {
          "path": "Element.extension",
          "min": 0,
          "max": "*"
        },
        "type": [
          {
            "code": "Extension"
          }
        ]
      },
      {
        "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 should be version specific.  This will ideally be the URI for the Resource Profile defining the extension, with the code for the extension after a #.",
        "min": 1,
        "max": "1",
        "base": {
          "path": "Extension.url",
          "min": 1,
          "max": "1"
        },
        "type": [
          {
            "code": "uri"
          }
        ],
        "fixedUri": "http://hl7.org/fhir/StructureDefinition/codesystem-oid",
        "mapping": [
          {
            "identity": "rim",
            "map": "N/A"
          }
        ]
      },
      {
        "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": 1,
        "max": "1",
        "base": {
          "path": "Extension.value[x]",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "uri"
          }
        ],
        "mapping": [
          {
            "identity": "rim",
            "map": "N/A"
          }
        ]
      }
    ]
  },
  "differential": {
    "element": [
      {
        "path": "Extension",
        "short": "OID assigned to the value set or code system",
        "definition": "The OID assigned the same object as the URI points to. Examples include OIDs assigned to code systems like SNOMED CT (urn:oid:2.16.840.1.113883..6.96) or LOINC (urn:oid:2.16.840.1.113883.6.1), value sets like AdministrativeGender (urn:oid:2.16.840.1.113883.11.1), identification systems like SSN (urn:oid:2.16.840.1.113883.4.1) etc.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "Extension"
          }
        ],
        "isModifier": false
      },
      {
        "path": "Extension.extension",
        "name": "extension",
        "max": "0"
      },
      {
        "path": "Extension.url",
        "type": [
          {
            "code": "uri"
          }
        ],
        "fixedUri": "http://hl7.org/fhir/StructureDefinition/codesystem-oid"
      },
      {
        "path": "Extension.value[x]",
        "min": 1,
        "type": [
          {
            "code": "uri"
          }
        ]
      }
    ]
  }
}

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.