HL7.FHIR.US.CCDA\Information Recipient Extension - Definitions

C-CDA on FHIR
1.2.0-ballot - CI Build United States of America flag

This page is part of the C-CDA on FHIR Implementation Guide (v1.2.0-ballot: STU 1 Ballot 4) based on FHIR R4. The current version which supercedes this version is 1.1.0. For a full list of available versions, see the Directory of published versions

Extension: InformationRecipientExtension - Detailed Descriptions

Active as of 2023-03-27

Definitions for the InformationRecipientExtension extension.

Differential Elements Table
Key Elements Table
Snapshot Elements Table

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

1. Extension
2. Extension.url
Fixed Value	http://hl7.org/fhir/us/ccda/StructureDefinition/InformationRecipientExtension
3. Extension.valueReference:valueReference
SliceName	valueReference
Control	1..?
Type	Reference(USCorePractitionerProfile\|USCorePractitionerRoleProfile\|USCorePatientProfile)
Must Support	true
Must Support Types	No must-support rules about the choice of types/profiles

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.
Control	0..* This element is affected by the following invariants: ele-1
Invariants	Defined 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.
Control	1..1
Type	uri
XML Representation	In the XML format, this property is represented as an attribute.
Summary	false
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 Value	http://hl7.org/fhir/us/ccda/StructureDefinition/InformationRecipientExtension
3. Extension.value[x]
Definition	Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Control	10..1
Type	Choice of: Reference, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
[x] Note	See Choice of Data Types for further information about how to use [x]
Summary	false
Invariants	Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
Slicing	This 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]:valueReference
SliceName	valueReference
Definition	Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Control	10..1
Type	Choice of: Reference(USCorePractitionerProfile\|USCorePractitionerRoleProfile\|USCorePatientProfile), date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
[x] Note	See Choice of Data Types for further information about how to use [x]
Must Support	true
Must Support Types	No must-support rules about the choice of types/profiles
Summary	false
Invariants	Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))

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

1. Extension
Definition	An Extension
Control	0..* 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.
Control	0..1
Type	string
XML Representation	In the XML format, this property is represented as an attribute.
Summary	false
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.
Control	0..*
Type	Extension
Summary	false
Alternate Names	extensions, 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.
Invariants	Defined 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())
Slicing	This 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.
Control	1..1
Type	uri
XML Representation	In the XML format, this property is represented as an attribute.
Summary	false
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 Value	http://hl7.org/fhir/us/ccda/StructureDefinition/InformationRecipientExtension
5. Extension.value[x]
Definition	Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Control	1..1
Type	Reference
[x] Note	See Choice of Data Types for further information about how to use [x]
Summary	false
Invariants	Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
Slicing	This 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]:valueReference
SliceName	valueReference
Definition	Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Control	1..1
Type	Reference(USCorePractitionerProfile\|USCorePractitionerRoleProfile\|USCorePatientProfile)
[x] Note	See Choice of Data Types for further information about how to use [x]
Must Support	true
Must Support Types	No must-support rules about the choice of types/profiles
Summary	false
Invariants	Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))

IG © 2020+ HL7 Structured Documents Working Group. Package hl7.fhir.us.ccda#1.2.0-ballot based on FHIR 4.0.1. Generated 2023-03-27
Links: Table of Contents | QA Report | Version History | | Propose a change