FHIR Data Segmentation for Privacy
1.0.0 - trial-use International flag

FHIR Data Segmentation for Privacy, published by HL7 Security Working Group. This is not an authorized publication; it is the continuous build for version 1.0.0). This version is based on the current content of https://github.com/HL7/fhir-security-label-ds4p/ and changes regularly. See the Directory of published versions

Extension: ExtensionSecLabelRelatedArtifact - Detailed Descriptions

Draft as of 2023-04-17

Definitions for the extension-sec-label-related-artifact extension.

Guidance on how to interpret the contents of this table can be found here.

1. Extension
2. Extension.url
Fixed Valuehttp://hl7.org/fhir/uv/security-label-ds4p/StructureDefinition/extension-sec-label-related-artifact
3. Extension.valueRelatedArtifact
Control1..?
TypeRelatedArtifact
InvariantsDefined on this element
ext-1: RelatedArtifact.type must be either 'justification' (where the RelatedArtifact is the basis for e.g., policy, contract, or patient consent) or 'documentation' (where the RelatedArtifact further documents the label e.g., provenance) (: type='documentation' or type='justification')
ext-2: Must provide at least one of RelatedArtifact.resource or RelatedArtifact.url or RelatedArtifact.document (: resource.exists() or url.exists() or document.exists())

Guidance on how to interpret the contents of this table can be found here.

1. Extension
Definition

An Extension

Optional Extension Element - found in all resources.

Control0..* This element is affected by the following invariants: ele-1
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
2. Extension.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Control1..1
Typeuri
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
Comments

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.

Fixed Valuehttp://hl7.org/fhir/uv/security-label-ds4p/StructureDefinition/extension-sec-label-related-artifact
3. Extension.value[x]
Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Control10..1
TypeChoice of: RelatedArtifact, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
[x] NoteSee Choice of Data Types for further information about how to use [x]
Summaryfalse
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Extension.value[x]. The slices are unordered and Closed, and can be differentiated using the following discriminators:
  • type @ $this
4. Extension.value[x]:valueRelatedArtifact
SliceNamevalueRelatedArtifact
Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Control10..1
TypeChoice of: RelatedArtifact, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
[x] NoteSee Choice of Data Types for further information about how to use [x]
Summaryfalse
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: RelatedArtifact.type must be either 'justification' (where the RelatedArtifact is the basis for e.g., policy, contract, or patient consent) or 'documentation' (where the RelatedArtifact further documents the label e.g., provenance) (: type='documentation' or type='justification')
ext-2: Must provide at least one of RelatedArtifact.resource or RelatedArtifact.url or RelatedArtifact.document (: resource.exists() or url.exists() or document.exists())

Guidance on how to interpret the contents of this table can be found here.

1. Extension
Definition

An Extension

Control0..* This element is affected by the following invariants: ele-1
2. Extension.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
3. Extension.extension
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.

Control0..*
TypeExtension
Summaryfalse
Alternate Namesextensions, user content
Comments

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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
4. Extension.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Control1..1
Typeuri
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
Comments

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.

Fixed Valuehttp://hl7.org/fhir/uv/security-label-ds4p/StructureDefinition/extension-sec-label-related-artifact
5. Extension.value[x]
Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Control1..1
TypeRelatedArtifact
[x] NoteSee Choice of Data Types for further information about how to use [x]
Summaryfalse
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Extension.value[x]. The slices are unordered and Closed, and can be differentiated using the following discriminators:
  • type @ $this
6. Extension.value[x]:valueRelatedArtifact
SliceNamevalueRelatedArtifact
Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Control1..1
TypeRelatedArtifact
[x] NoteSee Choice of Data Types for further information about how to use [x]
Summaryfalse
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: RelatedArtifact.type must be either 'justification' (where the RelatedArtifact is the basis for e.g., policy, contract, or patient consent) or 'documentation' (where the RelatedArtifact further documents the label e.g., provenance) (: type='documentation' or type='justification')
ext-2: Must provide at least one of RelatedArtifact.resource or RelatedArtifact.url or RelatedArtifact.document (: resource.exists() or url.exists() or document.exists())