GP Connect - Send Document

Part of the GP Connect product family
Note: A minor revision has been made to this version of the specification due to issues in some of the guidance.
Full details of changes can be found in the release notes in version 2.0.1-public-beta.

Profile: CareConnect-Composition-1

careSettingTypeExtensionI0..1Extension(CodeableConcept)
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemΣ1..1uri
valueΣ1..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(CareConnect-Organization-1)
statusΣ ?!1..1codeBinding
typeΣ1..1CodeableConceptBinding
classΣ0..1CodeableConcept
subjectΣ I1..1Reference(Resource)
encounterΣ I0..1Reference(CareConnect-Encounter-1)
dateΣ1..1dateTime
authorΣ I1..*Reference(Device | RelatedPerson | CareConnect-Practitioner-1 | CareConnect-Patient-1)
titleΣ1..1string
confidentialityΣ ?!0..1codeBinding
modeΣ1..*codeBinding
timeΣ0..1dateTime
partyΣ I0..1Reference(CareConnect-Organization-1 | CareConnect-Practitioner-1 | CareConnect-Patient-1)
custodianΣ I0..1Reference(CareConnect-Organization-1)
codeΣ1..1codeBinding
targetIdentifierIdentifier
targetReferenceReference(CareConnect-Composition-1)
codeΣ0..*CodeableConcept
periodΣ I0..1Period
detailΣ I0..*Reference(Resource)
title0..1string
code0..1CodeableConceptBinding
textI0..1Narrative
modeΣ ?!0..1codeBinding
orderedBy0..1CodeableConceptBinding
entryI0..*Reference(Resource)
emptyReasonI0..1CodeableConceptBinding
sectionI0..*see (section)
Composition
DefinitionA set of healthcare-related information that is assembled together into a single logical document that provides a single coherent statement of meaning, establishes its own context and that has clinical attestation with regard to who is making the statement. While a Composition defines the structure, it does not actually contain the content: rather the full content of a document is contained in a Bundle, of which the Composition is the first resource contained.
Cardinality0...*
Comments

While the focus of this specification is on patient-specific clinical statements, this resource can also apply to other healthcare-related statements such as study protocol designs, healthcare invoices and other activities that are not necessarily patient-specific or clinical.

Invariants
  • dom-2:If the resource is contained in another resource, it SHALL NOT contain nested Resources
    contained.contained.empty()
  • dom-1:If the resource is contained in another resource, it SHALL NOT contain any narrative
    contained.text.empty()
  • dom-4: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-3:If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
    contained.where(('#'+id in %resource.descendants().reference).not()).empty()
Mappings
  • rim:Entity. Role, or Act
  • rim:Document[classCode="DOC" and moodCode="EVN" and isNormalAct()]
  • cda:ClinicalDocument
  • w5:infrastructure.documents
Composition.id
DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Cardinality0...1
Typeid
SummaryTrue
Comments

The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
Composition.meta
DefinitionThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource.
Cardinality0...1
TypeMeta
SummaryTrue
Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
  • rim:N/A
Composition.implicitRules
DefinitionA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.
Cardinality0...1
Typeuri
ModifierTrue
SummaryTrue
Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element.

This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
Composition.language
DefinitionThe base language in which the resource is written.
Cardinality0...1
Typecode
Binding

A human language.

Common Languages (extensible)
Comments

Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
Composition.text
DefinitionA human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Cardinality0...1
TypeNarrative
Aliasnarrative, html, xhtml, display
Comments

Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded in formation is added later.

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
  • rim:N/A
  • rim:Act.text?
Composition.contained
DefinitionThese resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
Cardinality0...*
TypeResource
Aliasinline resources, anonymous resources, contained resources
Comments

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.

Mappings
  • rim:Entity. Role, or Act
  • rim:N/A
Composition.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the resource. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, 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.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
  • ext-1:Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim:n/a
  • rim:N/A
Composition.extension:careSettingTypeExtension
DefinitionOptional Extension Element - found in all resources.
Cardinality0...1
TypeExtension(CodeableConcept)
Aliasextensions, 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
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
  • ext-1:Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim:n/a
  • rim:N/A
Composition.modifierExtension
DefinitionMay be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
Cardinality0...*
TypeExtension
ModifierTrue
Aliasextensions, 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.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
  • ext-1:Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim:n/a
  • rim:N/A
Composition.identifier
DefinitionLogical identifier for the composition, assigned when created. This identifier stays constant as the composition is changed over time.
Cardinality0...1
TypeIdentifier
SummaryTrue
Comments

See discussion in resource definition for how these relate.

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
  • v2:CX / EI (occasionally, more often EI maps to a resource id or a URL)
  • rim:II - see see identifier pattern at http://wiki.hl7.org/index.php?title=Common_Design_Patterns#Identifier_Pattern for relevant discussion. The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
  • servd:Identifier
  • rim:Document.id / Document.setId
  • cda:.setId
  • w5:id
Composition.identifier.id
Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Comments

Note that FHIR strings may not exceed 1MB in size

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
Composition.identifier.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, 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.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
  • ext-1:Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim:n/a
  • rim:N/A
Composition.identifier.use
DefinitionThe purpose of this identifier.
Cardinality0...1
Typecode
Binding

Identifies the purpose for this identifier, if known .

IdentifierUse (required)
ModifierTrue
SummaryTrue
Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Comments

This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
  • v2:N/A
  • rim:Role.code or implied by context
Composition.identifier.type
DefinitionA coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
Cardinality0...1
TypeCodeableConcept
Binding

A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

Identifier Type Codes (extensible)
SummaryTrue
Requirements

Allows users to make use of identifiers when the identifier system is not known.

Comments

This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage.

Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
  • v2:CE/CNE/CWE
  • rim:CD
  • orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
  • v2:CX.5
  • rim:Role.code or implied by context
Composition.identifier.system
DefinitionEstablishes the namespace for the value - that is, a URL that describes a set values that are unique.
Cardinality1...1
Typeuri
SummaryTrue
Requirements

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

Comments

see http://en.wikipedia.org/wiki/Uniform_resource_identifier

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Examples
General

http://www.acme.com/identifiers/patient


Mappings
  • rim:n/a
  • v2:CX.4 / EI-2-4
  • rim:II.root or Role.id.root
  • servd:./IdentifierType
Composition.identifier.value
DefinitionThe portion of the identifier typically relevant to the user and which is unique within the context of the system.
Cardinality1...1
Typestring
SummaryTrue
Comments

If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension.

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Examples
General

123456


Mappings
  • rim:n/a
  • v2:CX.1 / EI.1
  • rim:II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
  • servd:./Value
Composition.identifier.period
DefinitionTime period during which identifier is/was valid for use.
Cardinality0...1
TypePeriod
SummaryTrue
Comments

This is not a duration - that's a measure of time (a separate type), but a duration that occurs at a fixed value of time. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). If duration is required, specify the type as Interval|Duration.

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
  • per-1:If present, start SHALL have a lower value than end
    start.empty() or end.empty() or (start <= end)
Mappings
  • rim:n/a
  • v2:DR
  • rim:IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
  • v2:CX.7 + CX.8
  • rim:Role.effectiveTime or implied by context
  • servd:./StartDate and ./EndDate
Composition.identifier.assigner
DefinitionOrganization that issued/manages the identifier.
Cardinality0...1
TypeReference(CareConnect-Organization-1)
SummaryTrue
Comments

The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
  • ref-1:SHALL have a contained resource if a local reference is provided
    reference.startsWith('#').not() or (reference.substring(1).trace('url') in %resource.contained.id.trace('ids'))
Mappings
  • rim:n/a
  • rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • v2:CX.4 / (CX.4,CX.9,CX.10)
  • rim:II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
  • servd:./IdentifierIssuingAuthority
Composition.status
DefinitionThe workflow/clinical status of this composition. The status is a marker for the clinical standing of the document.
Cardinality1...1
Typecode
Binding

The workflow/clinical status of the composition.

CompositionStatus (required)
ModifierTrue
SummaryTrue
Requirements

Need to be able to mark interim, amended, or withdrawn compositions or documents.

Comments

If a composition is marked as withdrawn, the compositions/documents in the series, or data from the composition or document series, should never be displayed to a user without being clearly marked as untrustworthy. The flag "entered-in-error" is why this element is labeled as a modifier of other elements.

Some reporting work flows require that the original narrative of a final document never be altered; instead, only new narrative can be added. The composition resource has no explicit status for explicitly noting whether this business rule is in effect. This would be handled by an extension if required.

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
  • rim:interim: .completionCode="IN" & ./statusCode[isNormalDatatype()]="active"; final: .completionCode="AU" && ./statusCode[isNormalDatatype()]="complete" and not(./inboundRelationship[typeCode="SUBJ" and isNormalActRelationship()]/source[subsumesCode("ActClass#CACT") and moodCode="EVN" and domainMember("ReviseComposition", code) and isNormalAct()]); amended: .completionCode="AU" && ./statusCode[isNormalDatatype()]="complete" and ./inboundRelationship[typeCode="SUBJ" and isNormalActRelationship()]/source[subsumesCode("ActClass#CACT") and moodCode="EVN" and domainMember("ReviseComposition", code) and isNormalAct() and statusCode="completed"]; withdrawn : .completionCode=NI && ./statusCode[isNormalDatatype()]="obsolete"
  • cda:n/a
  • w5:status
Composition.type
DefinitionSpecifies the particular kind of composition (e.g. History and Physical, Discharge Summary, Progress Note). This usually equates to the purpose of making the composition.
Cardinality1...1
TypeCodeableConcept
Binding

SNOMED CT Document Type

Care Connect Document Type (preferred)
SummaryTrue
Requirements

Key metadata element describing the composition, used in searching/filtering.

Comments

For Composition type, LOINC is ubiquitous and strongly endorsed by HL7. Most implementation guides will require a specific LOINC code, or use LOINC as an extensible binding.

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
  • v2:CE/CNE/CWE
  • rim:CD
  • orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim:./code
  • cda:.code
  • w5:class
Composition.class
DefinitionA categorization for the type of the composition - helps for indexing and searching. This may be implied by or derived from the code specified in the Composition Type.
Cardinality0...1
TypeCodeableConcept
Binding

High-level kind of a clinical document at a macro level.

FHIR Document Class Codes (example)
SummaryTrue
Requirements

Helps humans to assess whether the composition is of interest when viewing an index of compositions or documents.

Comments

This is a metadata field from XDS/MHD.

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
  • v2:CE/CNE/CWE
  • rim:CD
  • orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim:.outboundRelationship[typeCode="COMP].target[classCode="LIST", moodCode="EVN"].code
  • cda:n/a
  • w5:class
Composition.subject
DefinitionWho or what the composition is about. The composition can be about a person, (patient or healthcare practitioner), a device (e.g. a machine) or even a group of subjects (such as a document about a herd of livestock, or a set of patients that share a common exposure).
Cardinality1...1
TypeReference(Resource)
SummaryTrue
Requirements

Essential metadata for searching for the composition. Identifies who and/or what the composition/document is about.

Comments

For clinical documents, this is usually the patient.

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
  • ref-1:SHALL have a contained resource if a local reference is provided
    reference.startsWith('#').not() or (reference.substring(1).trace('url') in %resource.contained.id.trace('ids'))
Mappings
  • rim:n/a
  • rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • rim:.participation[typeCode="SBJ"].role[typeCode="PAT"]
  • cda:.recordTarget
  • w5:who.focus
Composition.encounter
DefinitionDescribes the clinical encounter or type of care this documentation is associated with.
Cardinality0...1
TypeReference(CareConnect-Encounter-1)
SummaryTrue
Requirements

Provides context for the composition and supports searching.

Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
  • ref-1:SHALL have a contained resource if a local reference is provided
    reference.startsWith('#').not() or (reference.substring(1).trace('url') in %resource.contained.id.trace('ids'))
Mappings
  • rim:n/a
  • rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • rim:unique(highest(./outboundRelationship[typeCode="SUBJ" and isNormalActRelationship()], priorityNumber)/target[moodCode="EVN" and classCode=("ENC", "PCPR") and isNormalAct])
  • cda:.componentOf.encompassingEncounter
  • w5:context
Composition.date
DefinitionThe composition editing time, when the composition was last logically changed by the author.
Cardinality1...1
TypedateTime
SummaryTrue
Requirements

dateTime is used for tracking, organizing versions and searching.

Comments

The Last Modified Date on the composition may be after the date of the document was attested without being changed.

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
  • rim:.effectiveTime[type="TS"]
  • cda:.effectiveTime
  • w5:when.done
Composition.author
DefinitionIdentifies who is responsible for the information in the composition, not necessarily who typed it in.
Cardinality1...*
TypeReference(Device | RelatedPerson | CareConnect-Practitioner-1 | CareConnect-Patient-1)
SummaryTrue
Requirements

Identifies who is responsible for the content.

Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
  • ref-1:SHALL have a contained resource if a local reference is provided
    reference.startsWith('#').not() or (reference.substring(1).trace('url') in %resource.contained.id.trace('ids'))
Mappings
  • rim:n/a
  • rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • rim:.participation[typeCode="AUT"].role[classCode="ASSIGNED"]
  • cda:.author.assignedAuthor
  • w5:who.author
Composition.title
DefinitionOfficial human-readable label for the composition.
Cardinality1...1
Typestring
SummaryTrue
Comments

For many compositions, the title is the same as the text or a display name of Composition.type (e.g. a "consultation" or "progress note"). Note that CDA does not make title mandatory, but there are no known cases where it is useful for title to be omitted, so it is mandatory here. Feedback on this requirement is welcome during the trial use period.

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
  • rim:./title
  • cda:.title
Composition.confidentiality
DefinitionThe code specifying the level of confidentiality of the Composition.
Cardinality0...1
Typecode
Binding

Codes specifying the level of confidentiality of the composition.

ConfidentialityClassification (required)
ModifierTrue
SummaryTrue
Comments

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).

This element is labeled as a modifier because highly confidential documents must not be treated as if they are not.

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
  • rim:.confidentialityCode
  • cda:.confidentialityCode
Composition.attester
DefinitionA participant who has attested to the accuracy of the composition/document.
Cardinality0...*
TypeBackboneElement
SummaryTrue
Requirements

Identifies responsibility for the accuracy of the composition content.

Comments

Only list each attester once.

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
  • rim:.participation[typeCode="AUTHEN"].role[classCode="ASSIGNED"]
  • cda:.authenticator/.legalAuthenticator
Composition.attester.id
Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Comments

Note that FHIR strings may not exceed 1MB in size

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
Composition.attester.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, 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.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
  • ext-1:Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim:n/a
  • rim:N/A
Composition.attester.modifierExtension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
Cardinality0...*
TypeExtension
ModifierTrue
SummaryTrue
Aliasextensions, user content, modifiers
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
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
  • ext-1:Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim:n/a
  • rim:N/A
Composition.attester.mode
DefinitionThe type of attestation the authenticator offers.
Cardinality1...*
Typecode
Binding

The way in which a person authenticated a composition.

CompositionAttestationMode (required)
SummaryTrue
Requirements

Indicates the level of authority of the attestation.

Comments

Use more than one code where a single attester has more than one mode (professional and legal are often paired).

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
  • rim:unique(./modeCode)
  • cda:implied by .authenticator/.legalAuthenticator
Composition.attester.time
DefinitionWhen the composition was attested by the party.
Cardinality0...1
TypedateTime
SummaryTrue
Requirements

Identifies when the information in the composition was deemed accurate. (Things may have changed since then.).

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
  • rim:./time[type="TS" and isNormalDatatype()]
  • cda:.authenticator.time
Composition.attester.party
DefinitionWho attested the composition in the specified way.
Cardinality0...1
TypeReference(CareConnect-Organization-1 | CareConnect-Practitioner-1 | CareConnect-Patient-1)
SummaryTrue
Requirements

Identifies who has taken on the responsibility for accuracy of the composition content.

Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
  • ref-1:SHALL have a contained resource if a local reference is provided
    reference.startsWith('#').not() or (reference.substring(1).trace('url') in %resource.contained.id.trace('ids'))
Mappings
  • rim:n/a
  • rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • rim:./role[classCode="ASSIGNED" and isNormalRole]/player[determinerCode="INST" and classCode=("DEV", "PSN") and isNormalEntity()] or ./role[classCode="ASSIGNED" and isNormalRole and not(player)]/scoper[determinerCode="INST" and classCode="ORG" and isNormalEntity()]
  • cda:.authenticator.assignedEnttty
  • w5:who.witness
Composition.custodian
DefinitionIdentifies the organization or group who is responsible for ongoing maintenance of and access to the composition/document information.
Cardinality0...1
TypeReference(CareConnect-Organization-1)
SummaryTrue
Requirements

Identifies where to go to find the current version, where to report issues, etc.

Comments

This is useful when documents are derived from a composition - provides guidance for how to get the latest version of the document. This is optional because this is sometimes not known by the authoring system, and can be inferred by context. However, it is important that this information be known when working with a derived document, so providing a custodian is encouraged.

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
  • ref-1:SHALL have a contained resource if a local reference is provided
    reference.startsWith('#').not() or (reference.substring(1).trace('url') in %resource.contained.id.trace('ids'))
Mappings
  • rim:n/a
  • rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • rim:.participation[typeCode="RCV"].role[classCode="CUST"].scoper[classCode="ORG" and determinerCode="INST"]
  • cda:.custodian.assignedCustodian
Composition.relatesTo
DefinitionRelationships that this composition has with other compositions or documents that already exist.
Cardinality0...1
TypeBackboneElement
SummaryTrue
Comments

A document is a version specific composition.

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
  • rim:.outboundRelationship
  • cda:.relatedDocument
Composition.relatesTo.id
Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Comments

Note that FHIR strings may not exceed 1MB in size

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
Composition.relatesTo.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, 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.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
  • ext-1:Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim:n/a
  • rim:N/A
Composition.relatesTo.modifierExtension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
Cardinality0...*
TypeExtension
ModifierTrue
SummaryTrue
Aliasextensions, user content, modifiers
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
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
  • ext-1:Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim:n/a
  • rim:N/A
Composition.relatesTo.code
DefinitionThe type of relationship that this composition has with anther composition or document.
Cardinality1...1
Typecode
Binding

The type of relationship between documents.

DocumentRelationshipType (required)
SummaryTrue
Comments

If this document appends another document, then the document cannot be fully understood without also accessing the referenced document.

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
  • rim:.outboundRelationship.typeCode
  • cda:.relatedDocument.typeCode
Composition.relatesTo.target[x]
DefinitionThe target composition/document of this relationship.
Cardinality1...1
TypeReference(CareConnect-Composition-1), Identifier
SummaryTrue
Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
  • rim:.target[classCode="DOC", moodCode="EVN"].id
  • cda:.relatedDocument.id
Composition.event
DefinitionThe clinical service, such as a colonoscopy or an appendectomy, being documented.
Cardinality0...*
TypeBackboneElement
SummaryTrue
Requirements

Provides context for the composition and creates a linkage between a resource describing an event and the composition created describing the event.

Comments

The event needs to be consistent with the type element, though can provide further information if desired.

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
  • rim:outboundRelationship[typeCode="SUBJ"].target[classCode<'ACT']
  • cda:.documentationOf.serviceEvent
Composition.event.id
Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Comments

Note that FHIR strings may not exceed 1MB in size

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
Composition.event.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, 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.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
  • ext-1:Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim:n/a
  • rim:N/A
Composition.event.modifierExtension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
Cardinality0...*
TypeExtension
ModifierTrue
SummaryTrue
Aliasextensions, user content, modifiers
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
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
  • ext-1:Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim:n/a
  • rim:N/A
Composition.event.code
DefinitionThis list of codes represents the main clinical acts, such as a colonoscopy or an appendectomy, being documented. In some cases, the event is inherent in the typeCode, such as a "History and Physical Report" in which the procedure being documented is necessarily a "History and Physical" act.
Cardinality0...*
TypeCodeableConcept
Binding

This list of codes represents the main clinical acts being documented.

v3 Code System ActCode (example)
SummaryTrue
Comments

An event can further specialize the act inherent in the typeCode, such as where it is simply "Procedure Report" and the procedure was a "colonoscopy". If one or more eventCodes are included, they SHALL NOT conflict with the values inherent in the classCode, practiceSettingCode or typeCode, as such a conflict would create an ambiguous situation. This short list of codes is provided to be used as key words for certain types of queries.

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
  • v2:CE/CNE/CWE
  • rim:CD
  • orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim:.code
  • cda:.code
Composition.event.period
DefinitionThe period of time covered by the documentation. There is no assertion that the documentation is a complete representation for this period, only that it documents events during this time.
Cardinality0...1
TypePeriod
SummaryTrue
Comments

This is not a duration - that's a measure of time (a separate type), but a duration that occurs at a fixed value of time. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). If duration is required, specify the type as Interval|Duration.

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
  • per-1:If present, start SHALL have a lower value than end
    start.empty() or end.empty() or (start <= end)
Mappings
  • rim:n/a
  • v2:DR
  • rim:IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
  • rim:.effectiveTime
  • cda:.effectiveTime
Composition.event.detail
DefinitionThe description and/or reference of the event(s) being documented. For example, this could be used to document such a colonoscopy or an appendectomy.
Cardinality0...*
TypeReference(Resource)
SummaryTrue
Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
  • ref-1:SHALL have a contained resource if a local reference is provided
    reference.startsWith('#').not() or (reference.substring(1).trace('url') in %resource.contained.id.trace('ids'))
Mappings
  • rim:n/a
  • rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • rim:.outboundRelationship[typeCode="SUBJ"].target
  • cda:n/a
Composition.section
DefinitionThe root of the sections that make up the composition.
Cardinality0...*
TypeBackboneElement
Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
  • cmp-1:A section must at least one of text, entries, or sub-sections
    text.exists() or entry.exists() or section.exists()
  • cmp-2:A section can only have an emptyReason if it is empty
    emptyReason.empty() or entry.empty()
Mappings
  • rim:n/a
  • rim:./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
  • cda:.component.structuredBody.component.section
Composition.section.id
Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Comments

Note that FHIR strings may not exceed 1MB in size

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
Composition.section.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, 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.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
  • ext-1:Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim:n/a
  • rim:N/A
Composition.section.modifierExtension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.
Cardinality0...*
TypeExtension
ModifierTrue
SummaryTrue
Aliasextensions, user content, modifiers
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
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
  • ext-1:Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim:n/a
  • rim:N/A
Composition.section.title
DefinitionThe label for this particular section. This will be part of the rendered content for the document, and is often used to build a table of contents.
Cardinality0...1
Typestring
Aliasheader, label, caption
Requirements

Section headings are often standardized for different types of documents. They give guidance to humans on how the document is organized.

Comments

The title identifies the section for a human reader. The title must be consistent with the narrative of the resource that is the target of the section.content reference. Generally, sections SHOULD have titles, but in some documents, it is unnecessary or inappropriate. Typically, this is where a section has subsections that have their own adequately distinguishing title, or documents that only have a single section. Most Implementation Guides will make section title to be a required element.

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
  • rim:./title
  • cda:.title
Composition.section.code
DefinitionA code identifying the kind of content contained within the section. This must be consistent with the section title.
Cardinality0...1
TypeCodeableConcept
Binding

Classification of a section of a composition/document.

Care Connect Composition Section Code (preferred)
Requirements

Provides computable standardized labels to topics within the document.

Comments

The code identifies the section for an automated processor of the document. This is particularly relevant when using profiles to control the structure of the document. If the section has content (instead of sub-sections), the section.code does not change the meaning or interpretation of the resource that is the content of the section in the comments for the section.code.

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
  • v2:CE/CNE/CWE
  • rim:CD
  • orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim:./code
  • cda:.code
Composition.section.text
DefinitionA human-readable narrative that contains the attested content of the section, used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative.
Cardinality0...1
TypeNarrative
Comments

Document profiles may define what content should be represented in the narrative to ensure clinical safety.

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
  • rim:N/A
  • rim:.text
  • cda:.text
Composition.section.mode
DefinitionHow the entry list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.
Cardinality0...1
Typecode
Binding

The processing mode that applies to this section.

ListMode (required)
ModifierTrue
SummaryTrue
Requirements

Sections are used in various ways, and it must be known in what way it is safe to use the entries in them.

Comments

This element is labeled as a modifier because a change list must not be mis-understood as a complete list.

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
  • rim:.outBoundRelationship[typeCode=COMP].target[classCode=OBS"].value
  • cda:n/a
  • w5:class
Composition.section.orderedBy
DefinitionSpecifies the order applied to the items in the section entries.
Cardinality0...1
TypeCodeableConcept
Binding

What order applies to the items in the entry.

List Order Codes (preferred)
Requirements

Important for presentation and rendering. Lists may be sorted to place more important information first or to group related entries.

Comments

Applications SHOULD render ordered lists in the order provided, but MAY allow users to re-order based on their own preferences as well. If there is no order specified, the order is unknown, though there may still be some order.

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
  • v2:CE/CNE/CWE
  • rim:CD
  • orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim:.outboundRelationship[typeCode=COMP].sequenceNumber > 1
  • cda:n/a
Composition.section.entry
DefinitionA reference to the actual resource from which the narrative in the section is derived.
Cardinality0...*
TypeReference(Resource)
Comments

If there are no entries in the list, an emptyReason SHOULD be provided.

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
  • ref-1:SHALL have a contained resource if a local reference is provided
    reference.startsWith('#').not() or (reference.substring(1).trace('url') in %resource.contained.id.trace('ids'))
Mappings
  • rim:n/a
  • rim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • rim:.outboundRelationship[typeCode=COMP] or .participation[typeCode=SBJ]
  • cda:.entry
Composition.section.emptyReason
DefinitionIf the section is empty, why the list is empty. An empty section typically has some text explaining the empty reason.
Cardinality0...1
TypeCodeableConcept
Binding

If a section is empty, why it is empty.

List Empty Reasons (preferred)
Requirements

Allows capturing things like "none exist" or "not asked" which can be important for most lists.

Comments

The various reasons for an empty section make a significant interpretation to its interpretation. Note that this code is for use when the entire section content has been suppressed, and not for when individual items are omitted - implementers may consider using a text note or a flag on an entry in these cases.

Invariants
  • ele-1:All FHIR elements must have a @value or children
    hasValue() | (children().count() > id.count())
Mappings
  • rim:n/a
  • v2:CE/CNE/CWE
  • rim:CD
  • orim:fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim:.inboundRelationship[typeCode=SUBJ,code<{ListEmptyReason}].value[type=CD]
  • cda:n/a
Composition.section.section
DefinitionA nested sub-section within this section.
Cardinality0...*
Typesee (section)
Comments

Nested sections are primarily used to help human readers navigate to particular portions of the document.

Mappings
  • rim:./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[moodCode="EVN" and classCode="DOCSECT" and isNormalAct]
  • cda:.component.section

Elements required for capability

Element Use CareConnect UK Core
id
meta.profile
meta.versionId
meta.lastUpdated
text
extension(careSettingTypeExtension)
identifier
status
type
class
subject
encounter
date
author
title
confidentiality
attester
custodian
relatesTo
event
section

id

Usage

Mandatory

Guidance

The id is the logical identifier for the CareConnect-Composition-1 profile.

Example
<id value="c3ea1a42-5aba-11ed-9b6a-0242ac120002" />


meta.versionId

Usage

Optional

Guidance

This guidance currently relies on MESH as the sending mechanism and, as such, harnesses the MESH .CTL <version> element to indicate the version of the document that is being sent.

However, it is recommended that the meta.versionId element be populated with the version of the document that is being sent. This will be the same version as that populated in the the MESH .CTL file.

Example
<meta>
    <versionId value="1" />
</meta>


meta.lastUpdated

Usage

Optional

Guidance

The meta.lastUpdated element does not need to be populated.

Example
<meta>
    <lastUpdated value="2022-11-02T14:19:00+00:00" />
</meta>


meta.profile

Usage

Mandatory

Guidance

The meta.profile contains a fixed value of the URL for the CareConnect-Composition-1 profile.

Example
<meta>
    <profile value="https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Composition-1" />
</meta>


meta.security

Usage

Optional

Guidance

The meta.security element does not need to be populated.

Example
<meta>
    <security>
        <coding>
            <system value="http://hl7.org/fhir/v3/Confidentiality" />
            <code value="L" />
            <display value="low" />
        </coding>
    </security>
</meta>


meta.tag

Usage

Optional

Guidance

The meta.tag element does not need to be populated for this capability.

Example
<meta>
    <tag>
        <coding>
            <system value="http://hl7.org/fhir/common-tags" />
            <code value="actionable" />
            <display value="Actionable" />
        </coding>
    </tag>
</meta>


text

Usage

Mandatory

Guidance

A human-readable description of the document being sent - using HTML.

Example
<text>
    <status value="generated" />
    <div xmlns="http://www.w3.org/1999/xhtml"><p>[document-title] for [patient-name], NHS Number: [nhs-number], seen at [practice-name], [ods-code], Version: [version-number]</p></div>
</text>


extension(careSettingTypeExtension)

Usage

Optional

Guidance

A value from a set of SNOMED codes which can be used to describe a type of care setting that the document has come from (if available).

The SNOMED codes have been selected from the 'Services' simple reference set of the SNOMED CT UK coding system.

The most complete list for this valueset can be found in the NHS FHIR HL7 UK Core guidance below:

https://simplifier.net/hl7fhirukcorer4/ukcore-caresettingtype

Example
<extension url="https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-CareSettingType-1">
    <valueCodeableConcept>
        <coding>
            <system value="http://snomed.info/sct" />
            <code value="789718008" />
            <display value="Cardiology service" />
        </coding>
    </valueCodeableConcept>
</extension>


identifier

Usage

Mandatory

Guidance

It is highly recommended that the logical id value is a Universally Unique Identifier (UUID) using a standard UUID generator available in most programming languages.


status

Usage

Mandatory

Guidance
Note:It is expected that this capability will not be used to send documents that are currently being worked on and, while it could potentially be used to do so, care must be taken by both the sender and receiver in how to handle documents with different statuses.

At the time of writing, the codesystem for CompositionStatus contains the following:

  • preliminary
  • final
  • amended
  • entered-in-error

View the up-to-date STU3 codesystem here

The diagram below represents how documents can transition through the available statuses .

Preliminary
Preliminary
Final
Final
Amended
Amended
Start
Start
Entered in error
Entered in error
Finish
Finish
Text is not SVG - cannot display

type

Usage

Mandatory

Guidance

A SNOMED code from the SNOMED Record composition type simple reference set (foundation metadata concept).

1127551000000109 | Record composition type simple reference set (foundation metadata concept) |

Example
<coding>
    <system value="http://snomed.info/sct" />
    <code value="325871000000103" />
    <display value="Remote consultation encounter type (record artifact)" />
</coding>


class

Usage

Optional

Guidance

A use case for this element has not been defined at the time of writing this guidance; as such, it is recommended that this element not be populated when sending a document.


subject

Usage

Mandatory

Guidance

The subject MUST contain a Patient resource profiled to the CareConnect-Patient-1 structure definition.

More information about how to populate this resource can be found in this guide using the link below.

Profile: CareConnect-Patient-1


encounter

Usage

Optional

Guidance

At the time of writing this guidance, a use case for sending a related encounter with a document was not defined; however, this may change in a subsequent version of this implementation guidance.


date

Usage

Mandatory

Guidance

The date element MUST contain the date and time that the message was created.


author

Usage

Required

Guidance

The author SHOULD contain an Practitioner resource profiled to the CareConnect-Practitioner-1 structure definition if it is known.

More information about how to populate this resource can be found in this guide using the link below.

Profile: CareConnect-Practitioner-1


title

Usage

Mandatory

Guidance

The title MUST contain a value in relation to the type of document you are sending.

Example
<title value="[Insert Document Title Here]" />


confidentiality

Usage

Mandatory

Guidance

The confidentiality MUST contain one of the following values:

  • N (Normal)
  • R (Restricted) - if the document is classed as confidential

Additional codes are defined by the base HL7 FHIR standard; however, guidance around how they should be interpreted cannot be defined at this time.

HL7 Value Set ConfidentialityClassification (v3)

Note: If a document is restricted, then the contents of the document may be redacted; however, the pointers to the document source will exist, should an actor require additional information about the payload.
Example
<!-- Normal -->
<confidentiality value="N" />

<!-- Restricted -->
<confidentiality value="R" />


attester

Usage

Optional

Guidance

At the time of writing this article, the attester element has not been defined; however, the Composition.attester.mode element may be pertinent for certain types of documents, in relation to the information they contain.

A future version of this guidance may request that this element be used.


custodian

Usage

Mandatory

Guidance

The subject MUST contain an Organization resource profiled to the CareConnect-Organization-1 structure definition.

More information about how to populate this resource can be found in this guide using the link below.

Profile: CareConnect-Organization-1


relatesTo

Usage

Mandatory

Guidance

See How to handle updates to documents for more information.

  • the relatesTo.code element MUST contain the fixed value of replaces

  • the relatesTo.targetIdentifier element MUST contain the UUID of the previous message if an updated or replacement document is being sent

Example
<relatesTo>
    <code value="replaces" />
    <targetIdentifier value="e255cf10-db3c-11ec-9d64-0242ac120002" />
</relatesTo>


event

Usage

Optional

Guidance

This element can be used to provide additional context about the document if the Composition.type does not suffice. The period element may also be populated.

Note: A use-case has not been identifier for populating the detail element.
Example
<coding>
    <system value="http://snomed.info/sct" />
    <code value="755491000000100" />
    <display value="Diabetes structured education programme completed (situation) " />
</coding>


section

Usage

Mandatory

Guidance

The section.entry element MUST reference all binary documents which are being attached.

More information about how to populate this resource can be found in this guide using the link below.

Profile: ITK-Attachment-Binary-1

Example
<section>
    <entry>
        <reference value="urn:uuid:0ffb9501-4182-485d-a9b7-39e7c20fe167" />
    </entry>
</section>

back to top