FHIR © HL7.org  |  FHIRsmith 4.0.1  |  Server Home  |  XIG Home  |  XIG Stats  | 

FHIR IG analytics

Packagehl7.fhir.uv.xver-r5.r4
Resource TypeStructureDefinition
IdStructureDefinition-ext-R5-Citation.status.json
FHIR VersionR4
Sourcehttp://hl7.org/fhir/uv/xver-r5.r4/0.1.0/StructureDefinition-ext-R5-Citation.status.html
URLhttp://hl7.org/fhir/5.0/StructureDefinition/extension-Citation.status
Version0.1.0
Statusactive
Date2026-03-17T21:02:03.8104715+00:00
NameExtensionCitation_Status
TitleR5: draft | active | retired | unknown (new)
Realmuv
Authorityhl7
DescriptionR5: `Citation.status` (new:code)
PurposeThis extension is part of the cross-version definitions generated to enable use of the element `Citation.status` as defined in FHIR R5 in FHIR R4. The source element is defined as: `Citation.status` 1..1 `code` Across FHIR versions, the element set has been mapped as: * R5: `Citation.status` 1..1 `code` Following are the generation technical comments: Element `Citation.status` is not mapped to FHIR R4, since FHIR R5 `Citation` is not mapped. Element `Citation.status` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).
TypeExtension
Kindcomplex-type

Resources that use this resource

ConceptMap
hl7.fhir.uv.xver-r5.r4#0.1.0R5-Citation-element-map-to-R4Cross-version mapping for FHIR R5 Citation to FHIR R4 Basic
hl7.fhir.uv.xver-r5.r3#0.1.0R5-Citation-element-map-to-R3Cross-version mapping for FHIR R5 Citation to FHIR STU3 Basic
StructureDefinition
hl7.fhir.uv.xver-r5.r4#0.1.0profile-CitationCross-version Profile for R5.Citation for use in FHIR R4

Resources that this resource uses

No resources found


Examples of Use for Extension

No extension usage examples found


Narrative

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

Generated Narrative: StructureDefinition ext-R5-Citation.status

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension ?!1..1Extension(4.0.1)R5: draft | active | retired | unknown (new)
This is a modifier extension
... url 1..1uri"http://hl7.org/fhir/5.0/StructureDefinition/extension-Citation.status"
... value[x] 1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required)

doco Documentation for this format

Source1

{
  "resourceType": "StructureDefinition",
  "id": "ext-R5-Citation.status",
  "text": {
    "status": "extensions",
    "div": "<!-- snip (see above) -->"
  },
  "extension": [
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
      "valueCode": "fhir"
    },
    {
      "extension": [
        {
          "url": "packageId",
          "valueId": "hl7.fhir.uv.xver-r5.r4"
        },
        {
          "url": "version",
          "valueString": "0.1.0"
        },
        {
          "url": "uri",
          "valueUri": "http://hl7.org/fhir/uv/xver/ImplementationGuide/hl7.fhir.uv.xver-r5.r4"
        }
      ],
      "url": "http://hl7.org/fhir/StructureDefinition/package-source"
    },
    {
      "extension": [
        {
          "url": "startFhirVersion",
          "valueCode": "4.0"
        },
        {
          "url": "endFhirVersion",
          "valueCode": "4.0"
        }
      ],
      "url": "http://hl7.org/fhir/StructureDefinition/version-specific-use"
    },
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
      "valueInteger": 0,
      "_valueInteger": {
        "extension": [
          {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
            "valueCanonical": "http://hl7.org/fhir/uv/xver/ImplementationGuide/hl7.fhir.uv.xver-r5.r4"
          }
        ]
      }
    },
    {
      "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/uv/xver/ImplementationGuide/hl7.fhir.uv.xver-r5.r4"
          }
        ]
      }
    }
  ],
  "url": "http://hl7.org/fhir/5.0/StructureDefinition/extension-Citation.status",
  "version": "0.1.0",
  "name": "ExtensionCitation_Status",
  "title": "R5: draft | active | retired | unknown (new)",
  "status": "active",
  "experimental": false,
  "date": "2026-03-17T21:02:03.8104715+00:00",
  "publisher": "FHIR Infrastructure",
  "contact": [
    {
      "name": "FHIR Infrastructure",
      "telecom": [
        {
          "system": "url",
          "value": "http://www.hl7.org/Special/committees/fiwg"
        }
      ]
    }
  ],
  "description": "R5: `Citation.status` (new:code)",
  "jurisdiction": [
    {
      "coding": [
        {
          "system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
          "code": "001",
          "display": "World"
        }
      ]
    }
  ],
  "purpose": "This extension is part of the cross-version definitions generated to enable use of the\r\nelement `Citation.status` as defined in FHIR R5\r\nin FHIR R4.\r\n\r\nThe source element is defined as:\r\n`Citation.status` 1..1 `code`\r\n\r\nAcross FHIR versions, the element set has been mapped as:\r\n*  R5: `Citation.status` 1..1 `code`\r\n\r\nFollowing are the generation technical comments:\r\nElement `Citation.status` is not mapped to FHIR R4, since FHIR R5 `Citation` is not mapped.\nElement `Citation.status` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).",
  "fhirVersion": "4.0.1",
  "mapping": [
    {
      "identity": "rim",
      "uri": "http://hl7.org/v3",
      "name": "RIM Mapping"
    }
  ],
  "kind": "complex-type",
  "abstract": false,
  "context": [
    {
      "type": "element",
      "expression": "Basic"
    }
  ],
  "type": "Extension",
  "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension|4.0.1",
  "derivation": "constraint",
  "snapshot": {
    "extension": [
      {
        "url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version",
        "valueString": "4.0.1"
      }
    ],
    "element": [
      {
        "id": "Extension",
        "path": "Extension",
        "short": "R5: draft | active | retired | unknown (new)",
        "definition": "R5: `Citation.status` (new:code)",
        "comment": "Element `Citation.status` is not mapped to FHIR R4, since FHIR R5 `Citation` is not mapped.\nElement `Citation.status` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).\nAllows filtering of summaries that are appropriate for use versus not. Use \"active\" when the citation record is the version for others to actively use, \"draft\" while you are developing the content, and \"retired\" when this record should no longer be used for any purpose.\n\nSee guidance around (not) making local changes to elements [here](https://hl7.org/fhir/canonicalreso.html#localization).",
        "min": 1,
        "max": "1",
        "base": {
          "path": "Extension",
          "min": 0,
          "max": "*"
        },
        "condition": [
          "ele-1"
        ],
        "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|4.0.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|4.0.1"
          }
        ],
        "isModifier": true,
        "isModifierReason": "This is labeled as \"Is Modifier\" because applications should not use a retired {{title}} without due consideration"
      },
      {
        "id": "Extension.id",
        "path": "Extension.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": "string"
              }
            ],
            "code": "http://hl7.org/fhirpath/System.String"
          }
        ],
        "isModifier": false,
        "isSummary": false,
        "mapping": [
          {
            "identity": "rim",
            "map": "n/a"
          }
        ]
      },
      {
        "id": "Extension.extension",
        "path": "Extension.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 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": "*"
        },
        "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|4.0.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|4.0.1"
          }
        ],
        "isModifier": false,
        "isSummary": false,
        "mapping": [
          {
            "identity": "rim",
            "map": "n/a"
          }
        ]
      },
      {
        "id": "Extension.url",
        "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.",
        "comment": "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 SHALL be a URI for the Structure Definition defining the extension.",
        "min": 1,
        "max": "1",
        "base": {
          "path": "Extension.url",
          "min": 1,
          "max": "1"
        },
        "type": [
          {
            "extension": [
              {
                "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
                "valueUrl": "uri"
              }
            ],
            "code": "http://hl7.org/fhirpath/System.String"
          }
        ],
        "fixedUri": "http://hl7.org/fhir/5.0/StructureDefinition/extension-Citation.status",
        "isModifier": false,
        "isSummary": false,
        "mapping": [
          {
            "identity": "rim",
            "map": "N/A"
          }
        ]
      },
      {
        "id": "Extension.value[x]",
        "path": "Extension.value[x]",
        "short": "draft | active | retired | unknown",
        "definition": "The status of this summary. Enables tracking the life-cycle of the content.",
        "comment": "Allows filtering of summaries that are appropriate for use versus not. Use \"active\" when the citation record is the version for others to actively use, \"draft\" while you are developing the content, and \"retired\" when this record should no longer be used for any purpose.\n\nSee guidance around (not) making local changes to elements [here](https://hl7.org/fhir/canonicalreso.html#localization).",
        "min": 1,
        "max": "1",
        "base": {
          "path": "Extension.value[x]",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "code"
          }
        ],
        "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|4.0.1"
          }
        ],
        "isModifier": false,
        "isSummary": false,
        "binding": {
          "strength": "required",
          "valueSet": "http://hl7.org/fhir/ValueSet/publication-status|4.0.1"
        },
        "mapping": [
          {
            "identity": "rim",
            "map": "N/A"
          }
        ]
      }
    ]
  },
  "differential": {
    "element": [
      {
        "id": "Extension",
        "path": "Extension",
        "short": "R5: draft | active | retired | unknown (new)",
        "definition": "R5: `Citation.status` (new:code)",
        "comment": "Element `Citation.status` is not mapped to FHIR R4, since FHIR R5 `Citation` is not mapped.\nElement `Citation.status` has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).\nAllows filtering of summaries that are appropriate for use versus not. Use \"active\" when the citation record is the version for others to actively use, \"draft\" while you are developing the content, and \"retired\" when this record should no longer be used for any purpose.\n\nSee guidance around (not) making local changes to elements [here](https://hl7.org/fhir/canonicalreso.html#localization).",
        "min": 1,
        "max": "1",
        "base": {
          "path": "Extension",
          "min": 0,
          "max": "*"
        },
        "isModifier": true,
        "isModifierReason": "This is labeled as \"Is Modifier\" because applications should not use a retired {{title}} without due consideration"
      },
      {
        "id": "Extension.url",
        "path": "Extension.url",
        "min": 1,
        "max": "1",
        "base": {
          "path": "Extension.url",
          "min": 1,
          "max": "1"
        },
        "fixedUri": "http://hl7.org/fhir/5.0/StructureDefinition/extension-Citation.status"
      },
      {
        "id": "Extension.value[x]",
        "path": "Extension.value[x]",
        "short": "draft | active | retired | unknown",
        "definition": "The status of this summary. Enables tracking the life-cycle of the content.",
        "comment": "Allows filtering of summaries that are appropriate for use versus not. Use \"active\" when the citation record is the version for others to actively use, \"draft\" while you are developing the content, and \"retired\" when this record should no longer be used for any purpose.\n\nSee guidance around (not) making local changes to elements [here](https://hl7.org/fhir/canonicalreso.html#localization).",
        "min": 1,
        "max": "1",
        "base": {
          "path": "Extension.value[x]",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "code"
          }
        ],
        "binding": {
          "strength": "required",
          "valueSet": "http://hl7.org/fhir/ValueSet/publication-status|4.0.1"
        }
      }
    ]
  }
}