{
"description": "abstract profile to ensure the reference portion of a codeable reference is used, and that the reference is a literal reference to some resource in a bundle",
"_filename": "StructureDefinition-literal-codeable-reference.json",
"package_name": "hl7.fhir.us.pq-cmc-fda",
"date": "2024-12-11T13:47:08+00:00",
"derivation": "constraint",
"publisher": "HL7 International / Biomedical Research and Regulation",
"fhirVersion": "5.0.0",
"jurisdiction": [ {
"coding": [ {
"code": "US",
"system": "urn:iso:std:iso:3166",
"display": "United States of America"
} ]
} ],
"name": "LiteralCodeableReference",
"mapping": [ {
"uri": "http://hl7.org/v3",
"name": "RIM Mapping",
"identity": "rim"
} ],
"abstract": true,
"type": "CodeableReference",
"experimental": null,
"resourceType": "StructureDefinition",
"title": "Literal Coded Reference",
"package_version": "1.0.0",
"extension": [ {
"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": "brr"
} ],
"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"
} ],
"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())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"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": true
}, {
"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": 1,
"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",
"profile": [ "http://hl7.org/fhir/us/pq-cmc-fda/StructureDefinition/literal-reference" ],
"aggregation": [ "bundled" ]
} ],
"mustSupport": true,
"max": "1",
"id": "CodeableReference.reference",
"base": {
"max": "1",
"min": 0,
"path": "CodeableReference.reference"
},
"isSummary": true
} ]
},
"status": "active",
"id": "1af426c6-aeff-4b38-a8ae-8e48beb87d5a",
"kind": "complex-type",
"url": "http://hl7.org/fhir/us/pq-cmc-fda/StructureDefinition/literal-codeable-reference",
"identifier": [ {
"value": "urn:oid:2.16.840.1.113883.4.642.40.36.42.62",
"system": "urn:ietf:rfc:3986"
} ],
"version": "1.0.0",
"differential": {
"element": [ {
"id": "CodeableReference.reference",
"min": 1,
"path": "CodeableReference.reference",
"type": [ {
"code": "Reference",
"profile": [ "http://hl7.org/fhir/us/pq-cmc-fda/StructureDefinition/literal-reference" ],
"aggregation": [ "bundled" ]
} ],
"mustSupport": true
} ]
},
"contact": [ {
"name": "HL7 International / Biomedical Research and Regulation",
"telecom": [ {
"value": "http://www.hl7.org/Special/committees/rcrim",
"system": "url"
}, {
"value": "brr@lists.HL7.org",
"system": "email"
} ]
} ],
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/CodeableReference"
}