Extensions for Using Data Elements from FHIR R4 in FHIR R4B
0.1.0 - STU International flag

Extensions for Using Data Elements from FHIR R4 in FHIR R4B - Downloaded Version null See the Directory of published versions

Resource Profile: Profile_R4_CompartmentDefinition_R4B

Official URL: http://hl7.org/fhir/4.0/StructureDefinition/profile-CompartmentDefinition Version: 0.1.0
Standards status: Trial-use Maturity Level: 0 Computable Name: Profile_R4_CompartmentDefinition_R4B

This cross-version profile allows R4 CompartmentDefinition content to be represented via FHIR R4B CompartmentDefinition resources.

Usages:

  • This Profile is not used by any profiles in this Implementation Guide

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. CompartmentDefinition C 0..* CompartmentDefinition(4.3.0) Compartment Definition for a resource
Constraints: cpd-0
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... url Σ 1..1 uri Canonical identifier for this compartment definition, represented as a URI (globally unique)
... status ?!Σ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
... code Σ 1..1 code Patient | Encounter | RelatedPerson | Practitioner | Device
Binding: CompartmentType (required): Which type a compartment definition describes.
... search Σ 1..1 boolean Whether the search syntax is supported

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
CompartmentDefinition.​status Base required PublicationStatus 📍4.3.0 FHIR Std.
CompartmentDefinition.​code Base required CompartmentType 📍4.3.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
cpd-0 warning CompartmentDefinition Name should be usable as an identifier for the module by machine processing applications such as code generation name.exists() implies name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
dom-2 error CompartmentDefinition If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error CompartmentDefinition If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where(((id.exists() and ('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url)))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(uri) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error CompartmentDefinition If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error CompartmentDefinition If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice CompartmentDefinition A resource should have narrative for robust management text.`div`.exists()
ele-1 error CompartmentDefinition.implicitRules, CompartmentDefinition.modifierExtension, CompartmentDefinition.url, CompartmentDefinition.name, CompartmentDefinition.status, CompartmentDefinition.code, CompartmentDefinition.search All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error CompartmentDefinition.modifierExtension Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from CompartmentDefinition

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. CompartmentDefinition 0..* CompartmentDefinition(4.3.0) Compartment Definition for a resource
... resource
.... code
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:code 0..1 code ​R4: code
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-CompartmentDefinition.resource.code
Binding: http://hl7.org/fhir/uv/xver/ValueSet/R4-resource-types-for-R4B (required): One of the resource types defined as part of this version of FHIR.

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. CompartmentDefinition C 0..* CompartmentDefinition(4.3.0) Compartment Definition for a resource
Constraints: cpd-0
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
Constraints: dom-r4b
... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... url Σ 1..1 uri Canonical identifier for this compartment definition, represented as a URI (globally unique)
... version Σ 0..1 string Business version of the compartment definition
... name Σ 1..1 string Name for this compartment definition (computer friendly)
... status ?!Σ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
... experimental Σ 0..1 boolean For testing purposes, not real usage
... date Σ 0..1 dateTime Date last changed
... publisher Σ 0..1 string Name of the publisher (organization or individual)
... contact Σ 0..* ContactDetail Contact details for the publisher
... description 0..1 markdown Natural language description of the compartment definition
... useContext Σ 0..* UsageContext The context that the content is intended to support
... purpose 0..1 markdown Why this compartment definition is defined
... code Σ 1..1 code Patient | Encounter | RelatedPerson | Practitioner | Device
Binding: CompartmentType (required): Which type a compartment definition describes.
... search Σ 1..1 boolean Whether the search syntax is supported
... resource Σ 0..* BackboneElement How a resource is related to the compartment
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... code Σ 1..1 code Name of resource type
Binding: ResourceType (required): One of the resource types defined as part of this version of FHIR.
..... id 0..1 string xml:id (or equivalent in JSON)
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
...... extension:code 0..1 code ​R4: code
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-CompartmentDefinition.resource.code
Binding: http://hl7.org/fhir/uv/xver/ValueSet/R4-resource-types-for-R4B (required): One of the resource types defined as part of this version of FHIR.
Constraints: ext-1
..... value 0..1 code Primitive value for code
.... param Σ 0..* string Search Parameter Name, or chained parameters
.... documentation 0..1 string Additional documentation about the resource and compartment

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
CompartmentDefinition.​language Base preferred Common Languages 📍4.3.0 FHIR Std.
CompartmentDefinition.​status Base required PublicationStatus 📍4.3.0 FHIR Std.
CompartmentDefinition.​code Base required CompartmentType 📍4.3.0 FHIR Std.
CompartmentDefinition.​resource.code Base required ResourceType 📍4.3.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
cpd-0 warning CompartmentDefinition Name should be usable as an identifier for the module by machine processing applications such as code generation name.exists() implies name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
dom-2 error CompartmentDefinition If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error CompartmentDefinition If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where(((id.exists() and ('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url)))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(uri) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error CompartmentDefinition If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error CompartmentDefinition If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice CompartmentDefinition A resource should have narrative for robust management text.`div`.exists()
dom-r4b warning CompartmentDefinition.contained Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems ($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic)
ele-1 error CompartmentDefinition.meta, CompartmentDefinition.implicitRules, CompartmentDefinition.language, CompartmentDefinition.text, CompartmentDefinition.extension, CompartmentDefinition.modifierExtension, CompartmentDefinition.url, CompartmentDefinition.version, CompartmentDefinition.name, CompartmentDefinition.status, CompartmentDefinition.experimental, CompartmentDefinition.date, CompartmentDefinition.publisher, CompartmentDefinition.contact, CompartmentDefinition.description, CompartmentDefinition.useContext, CompartmentDefinition.purpose, CompartmentDefinition.code, CompartmentDefinition.search, CompartmentDefinition.resource, CompartmentDefinition.resource.extension, CompartmentDefinition.resource.modifierExtension, CompartmentDefinition.resource.code, CompartmentDefinition.resource.code.extension, CompartmentDefinition.resource.code.extension:code, CompartmentDefinition.resource.param, CompartmentDefinition.resource.documentation All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error CompartmentDefinition.extension, CompartmentDefinition.modifierExtension, CompartmentDefinition.resource.extension, CompartmentDefinition.resource.modifierExtension, CompartmentDefinition.resource.code.extension, CompartmentDefinition.resource.code.extension:code Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from CompartmentDefinition

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. CompartmentDefinition C 0..* CompartmentDefinition(4.3.0) Compartment Definition for a resource
Constraints: cpd-0
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... url Σ 1..1 uri Canonical identifier for this compartment definition, represented as a URI (globally unique)
... status ?!Σ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
... code Σ 1..1 code Patient | Encounter | RelatedPerson | Practitioner | Device
Binding: CompartmentType (required): Which type a compartment definition describes.
... search Σ 1..1 boolean Whether the search syntax is supported

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
CompartmentDefinition.​status Base required PublicationStatus 📍4.3.0 FHIR Std.
CompartmentDefinition.​code Base required CompartmentType 📍4.3.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
cpd-0 warning CompartmentDefinition Name should be usable as an identifier for the module by machine processing applications such as code generation name.exists() implies name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
dom-2 error CompartmentDefinition If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error CompartmentDefinition If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where(((id.exists() and ('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url)))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(uri) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error CompartmentDefinition If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error CompartmentDefinition If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice CompartmentDefinition A resource should have narrative for robust management text.`div`.exists()
ele-1 error CompartmentDefinition.implicitRules, CompartmentDefinition.modifierExtension, CompartmentDefinition.url, CompartmentDefinition.name, CompartmentDefinition.status, CompartmentDefinition.code, CompartmentDefinition.search All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error CompartmentDefinition.modifierExtension Must have either extensions or value[x], not both extension.exists() != value.exists()

Differential View

This structure is derived from CompartmentDefinition

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. CompartmentDefinition 0..* CompartmentDefinition(4.3.0) Compartment Definition for a resource
... resource
.... code
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:code 0..1 code ​R4: code
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-CompartmentDefinition.resource.code
Binding: http://hl7.org/fhir/uv/xver/ValueSet/R4-resource-types-for-R4B (required): One of the resource types defined as part of this version of FHIR.

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. CompartmentDefinition C 0..* CompartmentDefinition(4.3.0) Compartment Definition for a resource
Constraints: cpd-0
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
Constraints: dom-r4b
... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... url Σ 1..1 uri Canonical identifier for this compartment definition, represented as a URI (globally unique)
... version Σ 0..1 string Business version of the compartment definition
... name Σ 1..1 string Name for this compartment definition (computer friendly)
... status ?!Σ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
... experimental Σ 0..1 boolean For testing purposes, not real usage
... date Σ 0..1 dateTime Date last changed
... publisher Σ 0..1 string Name of the publisher (organization or individual)
... contact Σ 0..* ContactDetail Contact details for the publisher
... description 0..1 markdown Natural language description of the compartment definition
... useContext Σ 0..* UsageContext The context that the content is intended to support
... purpose 0..1 markdown Why this compartment definition is defined
... code Σ 1..1 code Patient | Encounter | RelatedPerson | Practitioner | Device
Binding: CompartmentType (required): Which type a compartment definition describes.
... search Σ 1..1 boolean Whether the search syntax is supported
... resource Σ 0..* BackboneElement How a resource is related to the compartment
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... code Σ 1..1 code Name of resource type
Binding: ResourceType (required): One of the resource types defined as part of this version of FHIR.
..... id 0..1 string xml:id (or equivalent in JSON)
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
...... extension:code 0..1 code ​R4: code
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-CompartmentDefinition.resource.code
Binding: http://hl7.org/fhir/uv/xver/ValueSet/R4-resource-types-for-R4B (required): One of the resource types defined as part of this version of FHIR.
Constraints: ext-1
..... value 0..1 code Primitive value for code
.... param Σ 0..* string Search Parameter Name, or chained parameters
.... documentation 0..1 string Additional documentation about the resource and compartment

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
CompartmentDefinition.​language Base preferred Common Languages 📍4.3.0 FHIR Std.
CompartmentDefinition.​status Base required PublicationStatus 📍4.3.0 FHIR Std.
CompartmentDefinition.​code Base required CompartmentType 📍4.3.0 FHIR Std.
CompartmentDefinition.​resource.code Base required ResourceType 📍4.3.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
cpd-0 warning CompartmentDefinition Name should be usable as an identifier for the module by machine processing applications such as code generation name.exists() implies name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
dom-2 error CompartmentDefinition If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error CompartmentDefinition If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where(((id.exists() and ('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url)))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(uri) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error CompartmentDefinition If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error CompartmentDefinition If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice CompartmentDefinition A resource should have narrative for robust management text.`div`.exists()
dom-r4b warning CompartmentDefinition.contained Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems ($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic)
ele-1 error CompartmentDefinition.meta, CompartmentDefinition.implicitRules, CompartmentDefinition.language, CompartmentDefinition.text, CompartmentDefinition.extension, CompartmentDefinition.modifierExtension, CompartmentDefinition.url, CompartmentDefinition.version, CompartmentDefinition.name, CompartmentDefinition.status, CompartmentDefinition.experimental, CompartmentDefinition.date, CompartmentDefinition.publisher, CompartmentDefinition.contact, CompartmentDefinition.description, CompartmentDefinition.useContext, CompartmentDefinition.purpose, CompartmentDefinition.code, CompartmentDefinition.search, CompartmentDefinition.resource, CompartmentDefinition.resource.extension, CompartmentDefinition.resource.modifierExtension, CompartmentDefinition.resource.code, CompartmentDefinition.resource.code.extension, CompartmentDefinition.resource.code.extension:code, CompartmentDefinition.resource.param, CompartmentDefinition.resource.documentation All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error CompartmentDefinition.extension, CompartmentDefinition.modifierExtension, CompartmentDefinition.resource.extension, CompartmentDefinition.resource.modifierExtension, CompartmentDefinition.resource.code.extension, CompartmentDefinition.resource.code.extension:code Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from CompartmentDefinition

 

Other representations of profile: CSV, Excel, Schematron