Foundation
This
page
is
part
of
the
FHIR
Specification
(v3.0.2:
(v4.0.1:
R4
-
Mixed
Normative
and
STU
3).
)
in
it's
permanent
home
(it
will
always
be
available
at
this
URL).
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
R4
R3
R2
| Modeling and Methodology Work Group | Maturity Level : N/A |
|
Raw JSON ( canonical form + also see JSON Format Specification )
StructureDefinition for oid
{
"resourceType": "StructureDefinition",
"id": "oid",
"meta": {
"lastUpdated": "2019-10-24T11:53:00+11:00"
"resourceType" : "StructureDefinition",
"id" : "oid",
"meta" : {
"lastUpdated" : "2019-11-01T09:29:23.356+11:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
"text" : {
"status" : "generated",
"div" : "<div>!-- Snipped for Brevity --></div>"
},
"url": "http://hl7.org/fhir/StructureDefinition/oid",
"name": "oid",
"status": "draft",
"date": "2019-10-24T11:53:00+11:00",
"publisher": "HL7 FHIR Standard",
"contact": [
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "normative"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode" : "4.0.0"
}],
"url" : "http://hl7.org/fhir/StructureDefinition/oid",
"version" : "4.0.1",
"name" : "oid",
"status" : "active",
"date" : "2019-11-01T09:29:23+11:00",
"publisher" : "HL7 FHIR Standard",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
}]
}],
"description" : "Base StructureDefinition for oid type: An OID represented as a URI",
"fhirVersion" : "4.0.1",
"kind" : "primitive-type",
"abstract" : false,
"type" : "oid",
"baseDefinition" : "http://hl7.org/fhir/StructureDefinition/uri",
"derivation" : "specialization",
"snapshot" : {
"element" : [{
"id" : "oid",
"path" : "oid",
"short" : "Primitive Type oid",
"definition" : "An OID represented as a URI",
"comment" : "RFC 3001. See also ISO/IEC 8824:1990 €",
"min" : 0,
"max" : "*",
"base" : {
"path" : "oid",
"min" : 0,
"max" : "*"
},
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
}],
"isModifier" : false,
"isSummary" : false
},
{
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
}
]
}
],
"description": "Base StructureDefinition for oid type: An OID represented as a URI",
"fhirVersion": "3.0.2",
"kind": "primitive-type",
"abstract": false,
"type": "oid",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/uri",
"derivation": "specialization",
"snapshot": {
"element": [
{
"id": "oid",
"path": "oid",
"short": "Primitive Type oid",
"definition": "An OID represented as a URI",
"comment": "RFC 3001. See also ISO/IEC 8824:1990 €",
"min": 0,
"max": "*",
"base": {
"path": "oid",
"min": 0,
"max": "*"
},
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() | (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "Element"
}
]
"id" : "oid.id",
"path" : "oid.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" : "1"
},
{
"id": "oid.id",
"path": "oid.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": "1"
},
"type": [
{
"code": "string"
}
]
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "oid.extension",
"path" : "oid.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. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment" : "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" : "Element.extension",
"min" : 0,
"max" : "*"
},
{
"id": "oid.extension",
"path": "oid.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.",
"comment": "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": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
]
"type" : [{
"code" : "Extension"
}],
"constraint" : [{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() or (children().count() > id.count())",
"xpath" : "@value|f:*|h:div",
"source" : "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"id": "oid.value",
"path": "oid.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"
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
"source" : "http://hl7.org/fhir/StructureDefinition/Extension"
}],
"isModifier" : false,
"isSummary" : false
},
{
"id" : "oid.value",
"path" : "oid.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" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "string"
},
"type": [
{
"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": "xsd:anyURI"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-rdf-type",
"valueString": "xsd:string"
}
]
}
}
]
}
]
{
"url" : "http://hl7.org/fhir/StructureDefinition/regex",
"valueString" : "urn:oid:[0-2](\\.(0|[1-9][0-9]*))+"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}],
"isModifier" : false,
"isSummary" : false
}]
},
"differential": {
"element": [
{
"id": "oid",
"path": "oid",
"short": "Primitive Type oid",
"definition": "An OID represented as a URI",
"comment": "RFC 3001. See also ISO/IEC 8824:1990 €",
"min": 0,
"max": "*"
},
{
"id": "oid.value",
"path": "oid.value",
"representation": [
"xmlAttr"
],
"short": "Primitive value for oid",
"definition": "Primitive value for oid",
"min": 0,
"max": "1",
"type": [
{
"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": "xsd:anyURI"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-rdf-type",
"valueString": "xsd:string"
}
]
}
}
]
}
]
"differential" : {
"element" : [{
"id" : "oid",
"path" : "oid",
"short" : "Primitive Type oid",
"definition" : "An OID represented as a URI",
"comment" : "RFC 3001. See also ISO/IEC 8824:1990 €",
"min" : 0,
"max" : "*"
},
{
"id" : "oid.value",
"path" : "oid.value",
"representation" : ["xmlAttr"],
"short" : "Primitive value for oid",
"definition" : "Primitive value for oid",
"min" : 0,
"max" : "1",
"type" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl" : "oid"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/regex",
"valueString" : "urn:oid:[0-2](\\.(0|[1-9][0-9]*))+"
}],
"code" : "http://hl7.org/fhirpath/System.String"
}]
}]
}
}
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.
®©
HL7.org
2011+.
FHIR
Release
3
(STU;
v3.0.2-11200)
4
(Technical
Correction
#1)
(v4.0.1)
generated
on
Thurs,
Oct
24,
Fri,
Nov
1,
2019
11:53+1100.
09:34+1100.
QA
Page
Links:
Search
|
Version
History
|
Table
of
Contents
|
Credits
|
Compare
to
DSTU2
R3
|
|
Propose
a
change