FHIR © HL7.org  |  Server Home  |  XIG Home  |  Server Source  |  FHIR  

FHIR IG Statistics: StructureDefinition/literal-codeable-reference

Packagehl7.fhir.us.pq-cmc-fda
TypeStructureDefinition
Idliteral-codeable-reference
FHIR VersionR5
Sourcehttp://hl7.org/fhir/us/pq-cmc-fda/https://build.fhir.org/ig/HL7/FHIR-us-pq-cmc-fda/StructureDefinition-literal-codeable-reference.html
URLhttp://hl7.org/fhir/us/pq-cmc-fda/StructureDefinition/literal-codeable-reference
Version2.0.0
Statusactive
Date2025-07-03T13:07:08+00:00
NameLiteralCodeableReference
TitleLiteral Coded Reference
Realmus
Authorityhl7
DescriptionAn 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
TypeCodeableReference
Kindcomplex-type

Resources that use this resource

StructureDefinition
pqcmc-componentDrug Product Component
pqcmc-dp-ingredientDrug Product Batch Formula Ingredient
pqcmc-drug-product-descriptionDrug Product Description
pqcmc-drug-product-with-impuritiesDrug Product Impurities
pqcmc-product-batch-formulaDrug Product Batch Formula
pqcmc-product-partManufactured Drug Product

Resources that this resource uses

StructureDefinition
literal-referenceLiteral Reference

Narrative

Note: links and images are rebased to the (stated) source

Generated Narrative: StructureDefinition literal-codeable-reference

NameFlagsCard.TypeDescription & Constraintsdoco
.. CodeableReference CodeableReferenceThis is an abstract profile.
... reference S1..1LiteralReference() {b}Reference to a resource (by instance)

doco Documentation for this format

Source

{
  "resourceType": "StructureDefinition",
  "id": "literal-codeable-reference",
  "text": {
    "status": "extensions",
    "div": "<!-- snip (see above) -->"
  },
  "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"
    },
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
      "valueInteger": 2,
      "_valueInteger": {
        "extension": [
          {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
            "valueCanonical": "http://hl7.org/fhir/us/pq-cmc-fda/ImplementationGuide/hl7.fhir.us.pq-cmc-fda"
          }
        ]
      }
    },
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
      "valueCode": "trial-use",
      "_valueCode": {
        "extension": [
          {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
            "valueCanonical": "http://hl7.org/fhir/us/pq-cmc-fda/ImplementationGuide/hl7.fhir.us.pq-cmc-fda"
          }
        ]
      }
    }
  ],
  "url": "http://hl7.org/fhir/us/pq-cmc-fda/StructureDefinition/literal-codeable-reference",
  "identifier": [
    {
      "system": "urn:ietf:rfc:3986",
      "value": "urn:oid:2.16.840.1.113883.4.642.40.36.42.62"
    }
  ],
  "version": "2.0.0",
  "name": "LiteralCodeableReference",
  "title": "Literal Coded Reference",
  "status": "active",
  "date": "2025-07-03T13:07:08+00:00",
  "publisher": "HL7 International / Biomedical Research and Regulation",
  "contact": [
    {
      "name": "HL7 International / Biomedical Research and Regulation",
      "telecom": [
        {
          "system": "url",
          "value": "http://www.hl7.org/Special/committees/rcrim"
        },
        {
          "system": "email",
          "value": "brr@lists.HL7.org"
        }
      ]
    }
  ],
  "description": "An 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",
  "jurisdiction": [
    {
      "coding": [
        {
          "system": "urn:iso:std:iso:3166",
          "code": "US",
          "display": "United States of America"
        }
      ]
    }
  ],
  "fhirVersion": "5.0.0",
  "mapping": [
    {
      "identity": "rim",
      "uri": "http://hl7.org/v3",
      "name": "RIM Mapping"
    }
  ],
  "kind": "complex-type",
  "abstract": true,
  "type": "CodeableReference",
  "baseDefinition": "http://hl7.org/fhir/StructureDefinition/CodeableReference",
  "derivation": "constraint",
  "snapshot": {
    "extension": [
      {
        "url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version",
        "valueString": "5.0.0"
      }
    ],
    "element": [
      {
        "id": "CodeableReference",
        "path": "CodeableReference",
        "short": "Reference to a resource or a concept",
        "definition": "A reference to a resource (by instance), or instead, a reference to a concept defined in a terminology or ontology (by class).",
        "min": 0,
        "max": "*",
        "base": {
          "path": "CodeableReference",
          "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())",
            "source": "http://hl7.org/fhir/StructureDefinition/Element"
          }
        ],
        "isModifier": false,
        "mapping": [
          {
            "identity": "rim",
            "map": "n/a"
          }
        ]
      },
      {
        "id": "CodeableReference.id",
        "path": "CodeableReference.id",
        "representation": [
          "xmlAttr"
        ],
        "short": "Unique id for inter-element referencing",
        "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
        "min": 0,
        "max": "1",
        "base": {
          "path": "Element.id",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "extension": [
              {
                "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
                "valueUrl": "id"
              }
            ],
            "code": "http://hl7.org/fhirpath/System.String"
          }
        ],
        "condition": [
          "ele-1"
        ],
        "isModifier": false,
        "isSummary": false,
        "mapping": [
          {
            "identity": "rim",
            "map": "n/a"
          }
        ]
      },
      {
        "id": "CodeableReference.extension",
        "path": "CodeableReference.extension",
        "slicing": {
          "discriminator": [
            {
              "type": "value",
              "path": "url"
            }
          ],
          "description": "Extensions are always sliced by (at least) url",
          "rules": "open"
        },
        "short": "Additional content defined by implementations",
        "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.",
        "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"
          }
        ],
        "constraint": [
          {
            "key": "ele-1",
            "severity": "error",
            "human": "All FHIR elements must have a @value or children",
            "expression": "hasValue() or (children().count() > id.count())",
            "source": "http://hl7.org/fhir/StructureDefinition/Element"
          },
          {
            "key": "ext-1",
            "severity": "error",
            "human": "Must have either extensions or value[x], not both",
            "expression": "extension.exists() != value.exists()",
            "source": "http://hl7.org/fhir/StructureDefinition/Extension"
          }
        ],
        "isModifier": false,
        "isSummary": false,
        "mapping": [
          {
            "identity": "rim",
            "map": "n/a"
          }
        ]
      },
      {
        "id": "CodeableReference.concept",
        "path": "CodeableReference.concept",
        "short": "Reference to a concept (by class)",
        "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.",
        "min": 0,
        "max": "1",
        "base": {
          "path": "CodeableReference.concept",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "CodeableConcept"
          }
        ],
        "constraint": [
          {
            "key": "ele-1",
            "severity": "error",
            "human": "All FHIR elements must have a @value or children",
            "expression": "hasValue() or (children().count() > id.count())",
            "source": "http://hl7.org/fhir/StructureDefinition/Element"
          }
        ],
        "isModifier": false,
        "isSummary": true,
        "mapping": [
          {
            "identity": "rim",
            "map": "N/A"
          }
        ]
      },
      {
        "id": "CodeableReference.reference",
        "path": "CodeableReference.reference",
        "short": "Reference to a resource (by instance)",
        "definition": "A reference to a resource the provides exact details about the information being referenced.",
        "min": 1,
        "max": "1",
        "base": {
          "path": "CodeableReference.reference",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "Reference",
            "profile": [
              "http://hl7.org/fhir/us/pq-cmc-fda/StructureDefinition/literal-reference"
            ],
            "aggregation": [
              "bundled"
            ]
          }
        ],
        "constraint": [
          {
            "key": "ele-1",
            "severity": "error",
            "human": "All FHIR elements must have a @value or children",
            "expression": "hasValue() or (children().count() > id.count())",
            "source": "http://hl7.org/fhir/StructureDefinition/Element"
          }
        ],
        "mustSupport": true,
        "isModifier": false,
        "isSummary": true,
        "mapping": [
          {
            "identity": "rim",
            "map": "N/A"
          }
        ]
      }
    ]
  },
  "differential": {
    "element": [
      {
        "id": "CodeableReference.reference",
        "path": "CodeableReference.reference",
        "min": 1,
        "type": [
          {
            "code": "Reference",
            "profile": [
              "http://hl7.org/fhir/us/pq-cmc-fda/StructureDefinition/literal-reference"
            ],
            "aggregation": [
              "bundled"
            ]
          }
        ],
        "mustSupport": true
      }
    ]
  }
}