FHIR IG analytics

Resources that use this resource

Resources that this resource uses

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-R2-Composition.confidentiality

Name	Flags	Card.	Type	Description & Constraints
Extension	?!	0..1	Extension(4.3.0)	DSTU2: As defined by affinity domain additional codes This is a modifier extension
url		1..1	uri	"http://hl7.org/fhir/1.0/StructureDefinition/extension-Composition.confidentiality"
value[x]		0..1	code	As defined by affinity domain Binding: http://terminology.hl7.org/ValueSet/v3-Confidentiality|2.0.0 (required): Codes specifying the level of confidentiality of the composition.
Documentation for this format

Source1

{
  "resourceType": "StructureDefinition",
  "id": "ext-R2-Composition.confidentiality",
  "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-r2.r4b"
        },
        {
          "url": "version",
          "valueString": "0.1.0"
        },
        {
          "url": "uri",
          "valueUri": "http://hl7.org/fhir/uv/xver/ImplementationGuide/hl7.fhir.uv.xver-r2.r4b"
        }
      ],
      "url": "http://hl7.org/fhir/StructureDefinition/package-source"
    },
    {
      "extension": [
        {
          "url": "startFhirVersion",
          "valueCode": "4.3"
        },
        {
          "url": "endFhirVersion",
          "valueCode": "4.3"
        }
      ],
      "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-r2.r4b"
          }
        ]
      }
    },
    {
      "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-r2.r4b"
          }
        ]
      }
    }
  ],
  "url": "http://hl7.org/fhir/1.0/StructureDefinition/extension-Composition.confidentiality",
  "version": "0.1.0",
  "name": "ExtensionComposition_Confidentiality",
  "title": "DSTU2: As defined by affinity domain additional codes",
  "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": "DSTU2: `Composition.confidentiality` additional codes",
  "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 `Composition.confidentiality` as defined in FHIR DSTU2\r\nin FHIR R4B.\r\n\r\nThe source element is defined as:\r\n`Composition.confidentiality` 0..1 `code`\r\n\r\nAcross FHIR versions, the element set has been mapped as:\r\n*  DSTU2: `Composition.confidentiality` 0..1 `code`\n*  STU3: `Composition.confidentiality` 0..1 `code`\n*  R4: `Composition.confidentiality` 0..1 `code`\n*  R4B: `Composition.confidentiality` 0..1 `code`\r\n\r\nFollowing are the generation technical comments:\r\nThe target element context `Composition.confidentiality` is a primitive-type element and this extension needs to be defined as a modifier. The context was moved up to parent element `Composition`.\nElement `Composition.confidentiality` is mapped to FHIR R4B element `Composition.confidentiality` as `RelatedTo`.\nThe target element context `Composition.confidentiality` is a primitive-type element and this extension needs to be defined as a modifier. The context was moved up to parent element `Composition`.\nThe mappings for `Composition.confidentiality` do not allow expression of the necessary codes, per the bindings on the source and target.",
  "fhirVersion": "4.3.0",
  "mapping": [
    {
      "identity": "rim",
      "uri": "http://hl7.org/v3",
      "name": "RIM Mapping"
    }
  ],
  "kind": "complex-type",
  "abstract": false,
  "context": [
    {
      "type": "element",
      "expression": "Composition"
    }
  ],
  "type": "Extension",
  "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension|4.3.0",
  "derivation": "constraint",
  "snapshot": {
    "extension": [
      {
        "url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version",
        "valueString": "4.3.0"
      }
    ],
    "element": [
      {
        "id": "Extension",
        "path": "Extension",
        "short": "DSTU2: As defined by affinity domain additional codes",
        "definition": "DSTU2: `Composition.confidentiality` additional codes",
        "comment": "The target element context `Composition.confidentiality` is a primitive-type element and this extension needs to be defined as a modifier. The context was moved up to parent element `Composition`.\nElement `Composition.confidentiality` is mapped to FHIR R4B element `Composition.confidentiality` as `RelatedTo`.\nThe target element context `Composition.confidentiality` is a primitive-type element and this extension needs to be defined as a modifier. The context was moved up to parent element `Composition`.\nThe mappings for `Composition.confidentiality` do not allow expression of the necessary codes, per the bindings on the source and target.\nThe exact use of this element, and enforcement and issues related to highly sensitive documents are out of scope for the base specification, and delegated to implementation profiles (see security section).",
        "min": 0,
        "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 unless an empty Parameters resource",
            "expression": "hasValue() or (children().count() > id.count()) or $this is Parameters",
            "xpath": "@value|f:*|h:div|self::f:Parameters",
            "source": "http://hl7.org/fhir/StructureDefinition/Element|4.3.0"
          },
          {
            "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.3.0"
          }
        ],
        "isModifier": true,
        "isModifierReason": "This extension is a modifier because the source element `Composition.confidentiality` is flagged as a modifier element."
      },
      {
        "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": "id"
              }
            ],
            "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.3.0"
          },
          {
            "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.3.0"
          }
        ],
        "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/1.0/StructureDefinition/extension-Composition.confidentiality",
        "isModifier": false,
        "isSummary": false,
        "mapping": [
          {
            "identity": "rim",
            "map": "N/A"
          }
        ]
      },
      {
        "id": "Extension.value[x]",
        "path": "Extension.value[x]",
        "short": "As defined by affinity domain",
        "definition": "The code specifying the level of confidentiality of the Composition.",
        "comment": "The exact use of this element, and enforcement and issues related to highly sensitive documents are out of scope for the base specification, and delegated to implementation profiles (see security section).",
        "min": 0,
        "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.3.0"
          }
        ],
        "isModifier": false,
        "isSummary": false,
        "binding": {
          "strength": "required",
          "description": "Codes specifying the level of confidentiality of the composition.",
          "valueSet": "http://terminology.hl7.org/ValueSet/v3-Confidentiality|2.0.0"
        },
        "mapping": [
          {
            "identity": "rim",
            "map": "N/A"
          }
        ]
      }
    ]
  },
  "differential": {
    "element": [
      {
        "id": "Extension",
        "path": "Extension",
        "short": "DSTU2: As defined by affinity domain additional codes",
        "definition": "DSTU2: `Composition.confidentiality` additional codes",
        "comment": "The target element context `Composition.confidentiality` is a primitive-type element and this extension needs to be defined as a modifier. The context was moved up to parent element `Composition`.\nElement `Composition.confidentiality` is mapped to FHIR R4B element `Composition.confidentiality` as `RelatedTo`.\nThe target element context `Composition.confidentiality` is a primitive-type element and this extension needs to be defined as a modifier. The context was moved up to parent element `Composition`.\nThe mappings for `Composition.confidentiality` do not allow expression of the necessary codes, per the bindings on the source and target.\nThe exact use of this element, and enforcement and issues related to highly sensitive documents are out of scope for the base specification, and delegated to implementation profiles (see security section).",
        "min": 0,
        "max": "1",
        "base": {
          "path": "Extension",
          "min": 0,
          "max": "*"
        },
        "isModifier": true,
        "isModifierReason": "This extension is a modifier because the source element `Composition.confidentiality` is flagged as a modifier element."
      },
      {
        "id": "Extension.url",
        "path": "Extension.url",
        "min": 1,
        "max": "1",
        "base": {
          "path": "Extension.url",
          "min": 1,
          "max": "1"
        },
        "fixedUri": "http://hl7.org/fhir/1.0/StructureDefinition/extension-Composition.confidentiality"
      },
      {
        "id": "Extension.value[x]",
        "path": "Extension.value[x]",
        "short": "As defined by affinity domain",
        "definition": "The code specifying the level of confidentiality of the Composition.",
        "comment": "The exact use of this element, and enforcement and issues related to highly sensitive documents are out of scope for the base specification, and delegated to implementation profiles (see security section).",
        "min": 0,
        "max": "1",
        "base": {
          "path": "Extension.value[x]",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "code"
          }
        ],
        "binding": {
          "strength": "required",
          "description": "Codes specifying the level of confidentiality of the composition.",
          "valueSet": "http://terminology.hl7.org/ValueSet/v3-Confidentiality|2.0.0"
        }
      }
    ]
  }
}