{
"description": "CodeableReference Type: A reference to a resource (by instance), or instead, a reference to a concept defined in a terminology or ontology (by class).",
"_filename": "StructureDefinition-CodeableReference.json",
"package_name": "hl7.fhir.r6.examples",
"date": "2024-08-12T16:52:12+08:00",
"derivation": "specialization",
"publisher": "HL7 International / FHIR Infrastructure",
"fhirVersion": "6.0.0-ballot2",
"jurisdiction": [ {
"coding": [ {
"code": "001",
"system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
"display": "World"
} ]
} ],
"purpose": "This is a common pattern in record keeping - a reference may be made to a specific condition, observation, plan, or definition, or a reference may be made to a general concept defined in a knowledge base somewhere.",
"name": "CodeableReference",
"mapping": [ {
"uri": "http://hl7.org/v3",
"name": "RIM Mapping",
"identity": "rim"
} ],
"abstract": false,
"type": "CodeableReference",
"experimental": "false",
"resourceType": "StructureDefinition",
"title": null,
"package_version": "6.0.0-ballot2",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "draft"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-type-characteristics",
"valueCode": "has-target"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-type-characteristics",
"valueCode": "can-bind"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-type-characteristics",
"valueCode": "do-translations"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode": "fhir"
} ],
"snapshot": {
"element": [ {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "CodeableReference",
"min": 0,
"definition": "A reference to a resource (by instance), or instead, a reference to a concept defined in a terminology or ontology (by class).",
"isModifier": false,
"short": "Reference to a resource or a concept",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "draft"
} ],
"max": "*",
"id": "CodeableReference",
"base": {
"max": "*",
"min": 0,
"path": "CodeableReference"
}
}, {
"path": "CodeableReference.id",
"min": 0,
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"isModifier": false,
"short": "Unique id for inter-element referencing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "id"
} ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "CodeableReference.id",
"condition": [ "ele-1" ],
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "CodeableReference.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, 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.",
"isModifier": false,
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "CodeableReference.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.",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "CodeableReference.concept",
"min": 0,
"definition": "A reference to a concept - e.g. the information is identified by its general class to the degree of precision found in the terminology.",
"isModifier": false,
"short": "Reference to a concept (by class)",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"max": "1",
"id": "CodeableReference.concept",
"base": {
"max": "1",
"min": 0,
"path": "CodeableReference.concept"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "CodeableReference.reference",
"min": 0,
"definition": "A reference to a resource the provides exact details about the information being referenced.",
"isModifier": false,
"short": "Reference to a resource (by instance)",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Reference"
} ],
"max": "1",
"id": "CodeableReference.reference",
"base": {
"max": "1",
"min": 0,
"path": "CodeableReference.reference"
},
"isSummary": false
} ]
},
"status": "draft",
"id": "aed7628f-4072-494b-958b-456fa438b520",
"kind": "complex-type",
"url": "http://hl7.org/fhir/StructureDefinition/CodeableReference",
"version": "6.0.0-ballot2",
"differential": {
"element": [ {
"id": "CodeableReference",
"max": "*",
"min": 0,
"path": "CodeableReference",
"short": "Reference to a resource or a concept",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "draft"
} ],
"definition": "A reference to a resource (by instance), or instead, a reference to a concept defined in a terminology or ontology (by class)."
}, {
"id": "CodeableReference.concept",
"max": "1",
"min": 0,
"path": "CodeableReference.concept",
"type": [ {
"code": "CodeableConcept"
} ],
"short": "Reference to a concept (by class)",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"definition": "A reference to a concept - e.g. the information is identified by its general class to the degree of precision found in the terminology."
}, {
"id": "CodeableReference.reference",
"max": "1",
"min": 0,
"path": "CodeableReference.reference",
"type": [ {
"code": "Reference"
} ],
"short": "Reference to a resource (by instance)",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"definition": "A reference to a resource the provides exact details about the information being referenced."
} ]
},
"contact": [ {
"telecom": [ {
"value": "http://hl7.org/fhir",
"system": "url"
} ]
}, {
"telecom": [ {
"value": "http://www.hl7.org/Special/committees/fiwg",
"system": "url"
} ]
} ],
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/DataType"
}