Patient Cost Transparency Implementation Guide
2.0.0 - STU 2 - Draft
Patient Cost Transparency Implementation Guide
2.0.0 - STU 2 - Draft
Patient Cost Transparency Implementation Guide, published by HL7 International / Financial Management. This guide is not an authorized publication; it is the continuous build for version 2.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/davinci-pct/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.org/fhir/us/davinci-pct/StructureDefinition/davinci-pct-gfe-composition | Version: 2.0.0 | |||
| Standards status: Trial-use | Maturity Level: 1 | Computable Name: PCTGFEComposition | ||
| Other Identifiers: OID:2.16.840.1.113883.4.642.40.4.42.57 | ||||
PCT GFE Composition that assembles the contents of a GFE (represented by one or more individual GFE Bundles) into a single logical package. This version fo the Bundle is a document type that will enable versioning, signing and being referenced by a DocumentReference for searching and subscription notifications.
This profile does not include directly linked examples (available in an "Examples" tab at the top of this page) because the profile requires that referenced resources be included in the same bundle in which they exist.
As such, the example of this profile is included in PCT GFE Packet Institutional Example 1 and PCT GFE Packet Professional Example 1
Usages:
You can also check for usages in the FHIR IG Statistics
Changes since version 1.1.0:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter:   |
|---|---|---|---|---|
  Composition |
C | 0..* | Composition | A set of resources composed into a single coherent clinical statement with clinical attestation Constraints: pct-gfe-packet-composition-1 |
  implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
 Slices for extension |
2..* | Extension | Extension Slice: Unordered, Open by value:url | |
   extension:requestInitiationTime |
S | 1..1 | instant | Estimate Request instant (instance service was scheduled or estimate requested) URL: http://hl7.org/fhir/us/davinci-pct/StructureDefinition/requestInitiationTime |
| extension:gfeServiceLinkingInfo |
S | 0..1 | (Complex) | GFE Service Linking Information including planned period of service and a GFE linking identifier. Scheduled services SHALL have a plannedPeriodOfService valueDate or ValuePeriod URL: http://hl7.org/fhir/us/davinci-pct/StructureDefinition/gfeServiceLinkingInfo |
 extension:requestOriginationType |
S | 1..1 | CodeableConcept | Indicator as to whether the request for estimate originated from a scheduled or unscheduled service. URL: http://hl7.org/fhir/us/davinci-pct/StructureDefinition/requestOriginationType Binding: PCT GFE Request Type Codes ValueSet (required) |
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
 identifier |
Σ | 1..1 | Identifier | Version-independent identifier for the Composition |
| use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| system |
Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
 value |
Σ | 1..1 | string | The value that is unique Example General: 123456 |
| status |
?!Σ | 1..1 | code | preliminary | final | amended | entered-in-error Binding: CompositionStatus (required): The workflow/clinical status of the composition. |
| type |
Σ | 1..1 | CodeableConcept | Kind of composition (LOINC if possible) Binding: FHIRDocumentTypeCodes (preferred): Type of a composition. Required Pattern: At least the following |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations | |
 coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/davinci-pct/CodeSystem/PCTDocumentTypeTemporaryTrialUse | |
| version |
0..1 | string | Version of the system - if relevant | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: gfe-packet | |
| display |
0..1 | string | Representation defined by the system | |
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |
| text |
0..1 | string | Plain text representation of the concept | |
 Slices for category |
Σ | 1..* | CodeableConcept | Categorization of Composition Slice: Unordered, Open by value:coding Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level. |
| category:estimate |
SΣ | 1..1 | CodeableConcept | Categorization of Composition Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level. |
  Slices for coding |
Σ | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:$this |
| coding:estimate-coding |
SΣ | 1..1 | Coding | Code defined by a terminology system Required Pattern: At least the following |
 id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/davinci-pct/CodeSystem/PCTDocumentTypeTemporaryTrialUse | |
| version |
0..1 | string | Version of the system - if relevant | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: estimate | |
| display |
0..1 | string | Representation defined by the system | |
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |
 subject |
SΣ | 1..1 | Reference(US Core Patient Profile(7.0.0)) | Who and/or what the composition is about |
| date |
ΣC | 1..1 | dateTime | Composition editing time Constraints: pct-datetime-to-seconds |
| author |
Σ | 1..* | Reference(PCT Organization | PCT Practitioner) | All involved authoring parties, including all Good Faith Estimate (GFE) providers |
| title |
SΣ | 1..1 | string | Human Readable name/title |
| Slices for relatesTo |
0..* | BackboneElement | Relationship to other GFE packets. Required if this estimate is replacing another. Slice: Unordered, Open by value:code | |
 relatesTo:All Slices |
Content/Rules for all slices | |||
 modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| code |
1..1 | code | replaces | transforms | signs | appends Binding: DocumentRelationshipType (required): The type of relationship between documents. | |
 target[x] |
1..1 | Target of the relationship | ||
| targetIdentifier |
Identifier | |||
| targetReference |
Reference(Composition) | |||
| relatesTo:replaces |
S | 0..1 | BackboneElement | The identifier of the document (Composition.identifier) this estimate replaces |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| code |
1..1 | code | replaces | transforms | signs | appends Binding: DocumentRelationshipType (required): The type of relationship between documents. Required Pattern: replaces | |
| Slices for target[x] |
1..1 | Identifier | Target of the relationship Slice: Unordered, Closed by type:$this | |
| target[x]:targetIdentifier |
S | 1..1 | Identifier | Target of the relationship |
| use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| system |
Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
| value |
Σ | 1..1 | string | The value that is unique Example General: 123456 |
| Slices for section |
C | 2..* | BackboneElement | Sections Individual GFE Bundles Slice: Unordered, Open by value:code Constraints: cmp-1, cmp-2 |
| section:All Slices |
Content/Rules for all slices | |||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| section:coverage |
SC | 1..1 | BackboneElement | SHALL have a reference to a PCTCoverage resource, contained within the document bundle Constraints: cmp-1, cmp-2 |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| code |
1..1 | CodeableConcept | Classification of section (recommended) Binding: DocumentSectionCodes (example): Classification of a section of a composition/document. Required Pattern: At least the following | |
 id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/davinci-pct/CodeSystem/PCTDocumentSection | |
| version |
0..1 | string | Version of the system - if relevant | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: coverage-section | |
| display |
0..1 | string | Representation defined by the system | |
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |
| text |
0..1 | string | Plain text representation of the concept | |
| entry |
SC | 1..1 | Reference(PCT Coverage) {b} | A reference to data that supports this section |
| section:gfeBundle |
SC | 1..* | BackboneElement | SHALL reference one PCTGFEBundle or PCTGFEMissingBundle resource, which SHALL be contained in the document bundle, and the associated author (GFE Contributor) or proposed author (in the case of a missing GFE Bundle) contained in the document bundle. Constraints: cmp-1, cmp-2 |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| code |
1..1 | CodeableConcept | Classification of section (recommended) Binding: DocumentSectionCodes (example): Classification of a section of a composition/document. Required Pattern: At least the following | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/davinci-pct/CodeSystem/PCTDocumentSection | |
| version |
0..1 | string | Version of the system - if relevant | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: gfe-section | |
| display |
0..1 | string | Representation defined by the system | |
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |
| text |
0..1 | string | Plain text representation of the concept | |
| author |
S | 1..1 | Reference(PCT Practitioner | PCT Organization) {b} | Associated GFE author (GFE Contributor) or proposed author (in the case of a missing GFE Bundle) contained in the document bundle |
| entry |
SC | 1..1 | Reference(PCT GFE Bundle | PCT GFE Missing Bundle) {b} | A reference to data that supports this section |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Composition.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1From the FHIR Standard | |
| Composition.status | required | CompositionStatushttp://hl7.org/fhir/ValueSet/composition-status|4.0.1From the FHIR Standard | |
| Composition.type | preferred | Pattern Value: gfe-packethttp://hl7.org/fhir/ValueSet/doc-typecodesFrom the FHIR Standard | |
| Composition.category | example | DocumentClassValueSethttp://hl7.org/fhir/ValueSet/document-classcodesFrom the FHIR Standard | |
| Composition.category:estimate | example | DocumentClassValueSethttp://hl7.org/fhir/ValueSet/document-classcodesFrom the FHIR Standard | |
| Composition.relatesTo.code | required | DocumentRelationshipTypehttp://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1From the FHIR Standard | |
| Composition.relatesTo:replaces.code | required | Pattern Value: replaceshttp://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1From the FHIR Standard | |
| Composition.relatesTo:replaces.target[x]:targetIdentifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1From the FHIR Standard | |
| Composition.section:coverage.code | example | Pattern Value: coverage-sectionhttp://hl7.org/fhir/ValueSet/doc-section-codesFrom the FHIR Standard | |
| Composition.section:gfeBundle.code | example | Pattern Value: gfe-sectionhttp://hl7.org/fhir/ValueSet/doc-section-codesFrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| cmp-1 | error | Composition.section, Composition.section:coverage, Composition.section:gfeBundle | A section must contain at least one of text, entries, or sub-sections : text.exists() or entry.exists() or section.exists() | |
| cmp-2 | error | Composition.section, Composition.section:coverage, Composition.section:gfeBundle | A section can only have an emptyReason if it is empty : emptyReason.empty() or entry.empty() | |
| dom-2 | error | Composition | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Composition | 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 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(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | Composition | 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 | Composition | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Composition | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| pct-datetime-to-seconds | error | Composition.date | Datetime must be at least to seconds. : $this is dateTime implies $this.toString().length() >= 19 | |
| pct-gfe-packet-composition-1 | error | Composition | Scheduled service requests require a planned period of service : extension.where(url='http://hl7.org/fhir/us/davinci-pct/StructureDefinition/requestOriginationType' and value.ofType(CodeableConcept).coding.where(code='scheduled-request').exists()).exists() implies extension.where(url='http://hl7.org/fhir/us/davinci-pct/StructureDefinition/gfeServiceLinkingInfo' and extension.where(url = 'plannedPeriodOfService').exists()).exists() |
This structure is derived from Composition
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Composition |
C | 0..* | Composition | A set of resources composed into a single coherent clinical statement with clinical attestation Constraints: pct-gfe-packet-composition-1 |
| Slices for extension |
2..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:requestInitiationTime |
S | 1..1 | instant | Estimate Request instant (instance service was scheduled or estimate requested) URL: http://hl7.org/fhir/us/davinci-pct/StructureDefinition/requestInitiationTime |
| extension:gfeServiceLinkingInfo |
S | 0..1 | (Complex) | GFE Service Linking Information including planned period of service and a GFE linking identifier. Scheduled services SHALL have a plannedPeriodOfService valueDate or ValuePeriod URL: http://hl7.org/fhir/us/davinci-pct/StructureDefinition/gfeServiceLinkingInfo |
| extension:requestOriginationType |
S | 1..1 | CodeableConcept | Indicator as to whether the request for estimate originated from a scheduled or unscheduled service. URL: http://hl7.org/fhir/us/davinci-pct/StructureDefinition/requestOriginationType Binding: PCT GFE Request Type Codes ValueSet (required) |
| identifier |
1..1 | Identifier | Version-independent identifier for the Composition | |
| system |
1..1 | uri | The namespace for the identifier value | |
| value |
1..1 | string | The value that is unique | |
| type |
1..1 | CodeableConcept | Kind of composition (LOINC if possible) Required Pattern: At least the following | |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/davinci-pct/CodeSystem/PCTDocumentTypeTemporaryTrialUse | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: gfe-packet | |
| Slices for category |
1..* | CodeableConcept | Categorization of Composition Slice: Unordered, Open by value:coding | |
| category:estimate |
S | 1..1 | CodeableConcept | Categorization of Composition |
| Slices for coding |
1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:$this | |
| coding:estimate-coding |
S | 1..1 | Coding | Code defined by a terminology system Required Pattern: At least the following |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/davinci-pct/CodeSystem/PCTDocumentTypeTemporaryTrialUse | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: estimate | |
| subject |
S | 1..1 | Reference(US Core Patient Profile(7.0.0)) | Who and/or what the composition is about |
| date |
C | 1..1 | dateTime | Composition editing time Constraints: pct-datetime-to-seconds |
| author |
1..* | Reference(PCT Organization | PCT Practitioner) | All involved authoring parties, including all Good Faith Estimate (GFE) providers | |
| title |
S | 1..1 | string | Human Readable name/title |
| Slices for relatesTo |
0..* | BackboneElement | Relationship to other GFE packets. Required if this estimate is replacing another. Slice: Unordered, Open by value:code | |
| relatesTo:replaces |
S | 0..1 | BackboneElement | The identifier of the document (Composition.identifier) this estimate replaces |
| code |
1..1 | code | replaces | transforms | signs | appends Required Pattern: replaces | |
| Slices for target[x] |
1..1 | Identifier | Target of the relationship Slice: Unordered, Open by type:$this | |
| target[x]:targetIdentifier |
S | 1..1 | Identifier | Target of the relationship |
| system |
1..1 | uri | The namespace for the identifier value | |
| value |
1..1 | string | The value that is unique | |
| Slices for section |
2..* | BackboneElement | Sections Individual GFE Bundles Slice: Unordered, Open by value:code | |
| section:coverage |
S | 1..1 | BackboneElement | SHALL have a reference to a PCTCoverage resource, contained within the document bundle |
| code |
1..1 | CodeableConcept | Classification of section (recommended) Required Pattern: At least the following | |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/davinci-pct/CodeSystem/PCTDocumentSection | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: coverage-section | |
| entry |
S | 1..1 | Reference(PCT Coverage) {b} | A reference to data that supports this section |
| section:gfeBundle |
S | 1..* | BackboneElement | SHALL reference one PCTGFEBundle or PCTGFEMissingBundle resource, which SHALL be contained in the document bundle, and the associated author (GFE Contributor) or proposed author (in the case of a missing GFE Bundle) contained in the document bundle. |
| code |
1..1 | CodeableConcept | Classification of section (recommended) Required Pattern: At least the following | |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/davinci-pct/CodeSystem/PCTDocumentSection | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: gfe-section | |
| author |
S | 1..1 | Reference(PCT Practitioner | PCT Organization) {b} | Associated GFE author (GFE Contributor) or proposed author (in the case of a missing GFE Bundle) contained in the document bundle |
| entry |
S | 1..1 | Reference(PCT GFE Bundle | PCT GFE Missing Bundle) {b} | A reference to data that supports this section |
| Documentation for this format | ||||
| Id | Grade | Path(s) | Details | Requirements |
| pct-datetime-to-seconds | error | Composition.date | Datetime must be at least to seconds. : $this is dateTime implies $this.toString().length() >= 19 | |
| pct-gfe-packet-composition-1 | error | Composition | Scheduled service requests require a planned period of service : extension.where(url='http://hl7.org/fhir/us/davinci-pct/StructureDefinition/requestOriginationType' and value.ofType(CodeableConcept).coding.where(code='scheduled-request').exists()).exists() implies extension.where(url='http://hl7.org/fhir/us/davinci-pct/StructureDefinition/gfeServiceLinkingInfo' and extension.where(url = 'plannedPeriodOfService').exists()).exists() |
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Composition |
C | 0..* | Composition | A set of resources composed into a single coherent clinical statement with clinical attestation Constraints: pct-gfe-packet-composition-1 | ||||
| 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 | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| 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 | |||||
| Slices for extension |
2..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:requestInitiationTime |
S | 1..1 | instant | Estimate Request instant (instance service was scheduled or estimate requested) URL: http://hl7.org/fhir/us/davinci-pct/StructureDefinition/requestInitiationTime | ||||
| extension:gfeServiceLinkingInfo |
S | 0..1 | (Complex) | GFE Service Linking Information including planned period of service and a GFE linking identifier. Scheduled services SHALL have a plannedPeriodOfService valueDate or ValuePeriod URL: http://hl7.org/fhir/us/davinci-pct/StructureDefinition/gfeServiceLinkingInfo | ||||
| extension:requestOriginationType |
S | 1..1 | CodeableConcept | Indicator as to whether the request for estimate originated from a scheduled or unscheduled service. URL: http://hl7.org/fhir/us/davinci-pct/StructureDefinition/requestOriginationType Binding: PCT GFE Request Type Codes ValueSet (required) | ||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier |
Σ | 1..1 | Identifier | Version-independent identifier for the Composition | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
| type |
Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
| system |
Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
| value |
Σ | 1..1 | string | The value that is unique Example General: 123456 | ||||
| period |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| status |
?!Σ | 1..1 | code | preliminary | final | amended | entered-in-error Binding: CompositionStatus (required): The workflow/clinical status of the composition. | ||||
| type |
Σ | 1..1 | CodeableConcept | Kind of composition (LOINC if possible) Binding: FHIRDocumentTypeCodes (preferred): Type of a composition. Required Pattern: At least the following | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/davinci-pct/CodeSystem/PCTDocumentTypeTemporaryTrialUse | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: gfe-packet | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| text |
0..1 | string | Plain text representation of the concept | |||||
| Slices for category |
Σ | 1..* | CodeableConcept | Categorization of Composition Slice: Unordered, Open by value:coding Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level. | ||||
| category:estimate |
SΣ | 1..1 | CodeableConcept | Categorization of Composition Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level. | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| Slices for coding |
Σ | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:$this | ||||
| coding:estimate-coding |
SΣ | 1..1 | Coding | Code defined by a terminology system Required Pattern: At least the following | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/davinci-pct/CodeSystem/PCTDocumentTypeTemporaryTrialUse | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: estimate | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| text |
Σ | 0..1 | string | Plain text representation of the concept | ||||
| subject |
SΣ | 1..1 | Reference(US Core Patient Profile(7.0.0)) | Who and/or what the composition is about | ||||
| encounter |
Σ | 0..1 | Reference(Encounter) | Context of the Composition | ||||
| date |
ΣC | 1..1 | dateTime | Composition editing time Constraints: pct-datetime-to-seconds | ||||
| author |
Σ | 1..* | Reference(PCT Organization | PCT Practitioner) | All involved authoring parties, including all Good Faith Estimate (GFE) providers | ||||
| title |
SΣ | 1..1 | string | Human Readable name/title | ||||
| confidentiality |
Σ | 0..1 | code | As defined by affinity domain Binding: v3.ConfidentialityClassification (2014-03-26) (required): Codes specifying the level of confidentiality of the composition. | ||||
| attester |
0..* | BackboneElement | Attests to accuracy of composition | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| mode |
1..1 | code | personal | professional | legal | official Binding: CompositionAttestationMode (required): The way in which a person authenticated a composition. | |||||
| time |
0..1 | dateTime | When the composition was attested | |||||
| party |
0..1 | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole | Organization) | Who attested the composition | |||||
| custodian |
Σ | 0..1 | Reference(Organization) | Organization which maintains the composition | ||||
| Slices for relatesTo |
0..* | BackboneElement | Relationship to other GFE packets. Required if this estimate is replacing another. Slice: Unordered, Open by value:code | |||||
| relatesTo:All Slices |
Content/Rules for all slices | |||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| code |
1..1 | code | replaces | transforms | signs | appends Binding: DocumentRelationshipType (required): The type of relationship between documents. | |||||
| target[x] |
1..1 | Target of the relationship | ||||||
| targetIdentifier |
Identifier | |||||||
| targetReference |
Reference(Composition) | |||||||
| relatesTo:replaces |
S | 0..1 | BackboneElement | The identifier of the document (Composition.identifier) this estimate replaces | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| code |
1..1 | code | replaces | transforms | signs | appends Binding: DocumentRelationshipType (required): The type of relationship between documents. Required Pattern: replaces | |||||
| Slices for target[x] |
1..1 | Identifier | Target of the relationship Slice: Unordered, Closed by type:$this | |||||
| target[x]:targetIdentifier |
S | 1..1 | Identifier | Target of the relationship | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
| type |
Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
| system |
Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
| value |
Σ | 1..1 | string | The value that is unique Example General: 123456 | ||||
| period |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| event |
Σ | 0..* | BackboneElement | The clinical service(s) being documented | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| code |
Σ | 0..* | CodeableConcept | Code(s) that apply to the event being documented Binding: ActCode (3.0.0) (example): This list of codes represents the main clinical acts being documented. | ||||
| period |
Σ | 0..1 | Period | The period covered by the documentation | ||||
| detail |
Σ | 0..* | Reference(Resource) | The event(s) being documented | ||||
| Slices for section |
C | 2..* | BackboneElement | Sections Individual GFE Bundles Slice: Unordered, Open by value:code Constraints: cmp-1, cmp-2 | ||||
| section:All Slices |
Content/Rules for all slices | |||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| title |
0..1 | string | Label for section (e.g. for ToC) | |||||
| code |
0..1 | CodeableConcept | Classification of section (recommended) Binding: DocumentSectionCodes (example): Classification of a section of a composition/document. | |||||
| author |
0..* | Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization) | Who and/or what authored the section | |||||
| focus |
0..1 | Reference(Resource) | Who/what the section is about, when it is not about the subject of composition | |||||
| text |
C | 0..1 | Narrative | Text summary of the section, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | ||||
| mode |
0..1 | code | working | snapshot | changes Binding: ListMode (required): The processing mode that applies to this section. | |||||
| orderedBy |
0..1 | CodeableConcept | Order of section entries Binding: ListOrderCodes (preferred): What order applies to the items in the entry. | |||||
| entry |
C | 0..* | Reference(Resource) | A reference to data that supports this section | ||||
| emptyReason |
C | 0..1 | CodeableConcept | Why the section is empty Binding: ListEmptyReasons (preferred): If a section is empty, why it is empty. | ||||
| section |
C | 0..* | See section (Composition) | Nested Section | ||||
| section:coverage |
SC | 1..1 | BackboneElement | SHALL have a reference to a PCTCoverage resource, contained within the document bundle Constraints: cmp-1, cmp-2 | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| title |
0..1 | string | Label for section (e.g. for ToC) | |||||
| code |
1..1 | CodeableConcept | Classification of section (recommended) Binding: DocumentSectionCodes (example): Classification of a section of a composition/document. Required Pattern: At least the following | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/davinci-pct/CodeSystem/PCTDocumentSection | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: coverage-section | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| text |
0..1 | string | Plain text representation of the concept | |||||
| author |
0..* | Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization) | Who and/or what authored the section | |||||
| focus |
0..1 | Reference(Resource) | Who/what the section is about, when it is not about the subject of composition | |||||
| text |
C | 0..1 | Narrative | Text summary of the section, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | ||||
| mode |
0..1 | code | working | snapshot | changes Binding: ListMode (required): The processing mode that applies to this section. | |||||
| orderedBy |
0..1 | CodeableConcept | Order of section entries Binding: ListOrderCodes (preferred): What order applies to the items in the entry. | |||||
| entry |
SC | 1..1 | Reference(PCT Coverage) {b} | A reference to data that supports this section | ||||
| emptyReason |
C | 0..1 | CodeableConcept | Why the section is empty Binding: ListEmptyReasons (preferred): If a section is empty, why it is empty. | ||||
| section |
C | 0..* | See section (Composition) | Nested Section | ||||
| section:gfeBundle |
SC | 1..* | BackboneElement | SHALL reference one PCTGFEBundle or PCTGFEMissingBundle resource, which SHALL be contained in the document bundle, and the associated author (GFE Contributor) or proposed author (in the case of a missing GFE Bundle) contained in the document bundle. Constraints: cmp-1, cmp-2 | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| title |
0..1 | string | Label for section (e.g. for ToC) | |||||
| code |
1..1 | CodeableConcept | Classification of section (recommended) Binding: DocumentSectionCodes (example): Classification of a section of a composition/document. Required Pattern: At least the following | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/davinci-pct/CodeSystem/PCTDocumentSection | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: gfe-section | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| text |
0..1 | string | Plain text representation of the concept | |||||
| author |
S | 1..1 | Reference(PCT Practitioner | PCT Organization) {b} | Associated GFE author (GFE Contributor) or proposed author (in the case of a missing GFE Bundle) contained in the document bundle | ||||
| focus |
0..1 | Reference(Resource) | Who/what the section is about, when it is not about the subject of composition | |||||
| text |
C | 0..1 | Narrative | Text summary of the section, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | ||||
| mode |
0..1 | code | working | snapshot | changes Binding: ListMode (required): The processing mode that applies to this section. | |||||
| orderedBy |
0..1 | CodeableConcept | Order of section entries Binding: ListOrderCodes (preferred): What order applies to the items in the entry. | |||||
| entry |
SC | 1..1 | Reference(PCT GFE Bundle | PCT GFE Missing Bundle) {b} | A reference to data that supports this section | ||||
| emptyReason |
C | 0..1 | CodeableConcept | Why the section is empty Binding: ListEmptyReasons (preferred): If a section is empty, why it is empty. | ||||
| section |
C | 0..* | See section (Composition) | Nested Section | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| Composition.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesFrom the FHIR Standard
| ||||
| Composition.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1From the FHIR Standard | ||||
| Composition.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-typeFrom the FHIR Standard | ||||
| Composition.status | required | CompositionStatushttp://hl7.org/fhir/ValueSet/composition-status|4.0.1From the FHIR Standard | ||||
| Composition.type | preferred | Pattern Value: gfe-packethttp://hl7.org/fhir/ValueSet/doc-typecodesFrom the FHIR Standard | ||||
| Composition.category | example | DocumentClassValueSethttp://hl7.org/fhir/ValueSet/document-classcodesFrom the FHIR Standard | ||||
| Composition.category:estimate | example | DocumentClassValueSethttp://hl7.org/fhir/ValueSet/document-classcodesFrom the FHIR Standard | ||||
| Composition.confidentiality | required | v3.ConfidentialityClassificationhttp://terminology.hl7.org/ValueSet/v3-ConfidentialityClassification|2014-03-26From the FHIR Standard | ||||
| Composition.attester.mode | required | CompositionAttestationModehttp://hl7.org/fhir/ValueSet/composition-attestation-mode|4.0.1From the FHIR Standard | ||||
| Composition.relatesTo.code | required | DocumentRelationshipTypehttp://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1From the FHIR Standard | ||||
| Composition.relatesTo:replaces.code | required | Pattern Value: replaceshttp://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1From the FHIR Standard | ||||
| Composition.relatesTo:replaces.target[x]:targetIdentifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1From the FHIR Standard | ||||
| Composition.relatesTo:replaces.target[x]:targetIdentifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-typeFrom the FHIR Standard | ||||
| Composition.event.code | example | ActCodehttp://terminology.hl7.org/ValueSet/v3-ActCode|3.0.0 | ||||
| Composition.section.code | example | DocumentSectionCodeshttp://hl7.org/fhir/ValueSet/doc-section-codesFrom the FHIR Standard | ||||
| Composition.section.mode | required | ListModehttp://hl7.org/fhir/ValueSet/list-mode|4.0.1From the FHIR Standard | ||||
| Composition.section.orderedBy | preferred | ListOrderCodeshttp://hl7.org/fhir/ValueSet/list-orderFrom the FHIR Standard | ||||
| Composition.section.emptyReason | preferred | ListEmptyReasonshttp://hl7.org/fhir/ValueSet/list-empty-reasonFrom the FHIR Standard | ||||
| Composition.section:coverage.code | example | Pattern Value: coverage-sectionhttp://hl7.org/fhir/ValueSet/doc-section-codesFrom the FHIR Standard | ||||
| Composition.section:coverage.mode | required | ListModehttp://hl7.org/fhir/ValueSet/list-mode|4.0.1From the FHIR Standard | ||||
| Composition.section:coverage.orderedBy | preferred | ListOrderCodeshttp://hl7.org/fhir/ValueSet/list-orderFrom the FHIR Standard | ||||
| Composition.section:coverage.emptyReason | preferred | ListEmptyReasonshttp://hl7.org/fhir/ValueSet/list-empty-reasonFrom the FHIR Standard | ||||
| Composition.section:gfeBundle.code | example | Pattern Value: gfe-sectionhttp://hl7.org/fhir/ValueSet/doc-section-codesFrom the FHIR Standard | ||||
| Composition.section:gfeBundle.mode | required | ListModehttp://hl7.org/fhir/ValueSet/list-mode|4.0.1From the FHIR Standard | ||||
| Composition.section:gfeBundle.orderedBy | preferred | ListOrderCodeshttp://hl7.org/fhir/ValueSet/list-orderFrom the FHIR Standard | ||||
| Composition.section:gfeBundle.emptyReason | preferred | ListEmptyReasonshttp://hl7.org/fhir/ValueSet/list-empty-reasonFrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| cmp-1 | error | Composition.section, Composition.section:coverage, Composition.section:gfeBundle | A section must contain at least one of text, entries, or sub-sections : text.exists() or entry.exists() or section.exists() | |
| cmp-2 | error | Composition.section, Composition.section:coverage, Composition.section:gfeBundle | A section can only have an emptyReason if it is empty : emptyReason.empty() or entry.empty() | |
| dom-2 | error | Composition | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Composition | 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 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(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | Composition | 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 | Composition | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Composition | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| pct-datetime-to-seconds | error | Composition.date | Datetime must be at least to seconds. : $this is dateTime implies $this.toString().length() >= 19 | |
| pct-gfe-packet-composition-1 | error | Composition | Scheduled service requests require a planned period of service : extension.where(url='http://hl7.org/fhir/us/davinci-pct/StructureDefinition/requestOriginationType' and value.ofType(CodeableConcept).coding.where(code='scheduled-request').exists()).exists() implies extension.where(url='http://hl7.org/fhir/us/davinci-pct/StructureDefinition/gfeServiceLinkingInfo' and extension.where(url = 'plannedPeriodOfService').exists()).exists() |
This structure is derived from Composition
Summary
Mandatory: 17 elements(3 nested mandatory elements)
Must-Support: 14 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Maturity: 1
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Composition |
C | 0..* | Composition | A set of resources composed into a single coherent clinical statement with clinical attestation Constraints: pct-gfe-packet-composition-1 |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
| Slices for extension |
2..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:requestInitiationTime |
S | 1..1 | instant | Estimate Request instant (instance service was scheduled or estimate requested) URL: http://hl7.org/fhir/us/davinci-pct/StructureDefinition/requestInitiationTime |
| extension:gfeServiceLinkingInfo |
S | 0..1 | (Complex) | GFE Service Linking Information including planned period of service and a GFE linking identifier. Scheduled services SHALL have a plannedPeriodOfService valueDate or ValuePeriod URL: http://hl7.org/fhir/us/davinci-pct/StructureDefinition/gfeServiceLinkingInfo |
| extension:requestOriginationType |
S | 1..1 | CodeableConcept | Indicator as to whether the request for estimate originated from a scheduled or unscheduled service. URL: http://hl7.org/fhir/us/davinci-pct/StructureDefinition/requestOriginationType Binding: PCT GFE Request Type Codes ValueSet (required) |
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier |
Σ | 1..1 | Identifier | Version-independent identifier for the Composition |
| use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| system |
Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
| value |
Σ | 1..1 | string | The value that is unique Example General: 123456 |
| status |
?!Σ | 1..1 | code | preliminary | final | amended | entered-in-error Binding: CompositionStatus (required): The workflow/clinical status of the composition. |
| type |
Σ | 1..1 | CodeableConcept | Kind of composition (LOINC if possible) Binding: FHIRDocumentTypeCodes (preferred): Type of a composition. Required Pattern: At least the following |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/davinci-pct/CodeSystem/PCTDocumentTypeTemporaryTrialUse | |
| version |
0..1 | string | Version of the system - if relevant | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: gfe-packet | |
| display |
0..1 | string | Representation defined by the system | |
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |
| text |
0..1 | string | Plain text representation of the concept | |
| Slices for category |
Σ | 1..* | CodeableConcept | Categorization of Composition Slice: Unordered, Open by value:coding Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level. |
| category:estimate |
SΣ | 1..1 | CodeableConcept | Categorization of Composition Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level. |
| Slices for coding |
Σ | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:$this |
| coding:estimate-coding |
SΣ | 1..1 | Coding | Code defined by a terminology system Required Pattern: At least the following |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/davinci-pct/CodeSystem/PCTDocumentTypeTemporaryTrialUse | |
| version |
0..1 | string | Version of the system - if relevant | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: estimate | |
| display |
0..1 | string | Representation defined by the system | |
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |
| subject |
SΣ | 1..1 | Reference(US Core Patient Profile(7.0.0)) | Who and/or what the composition is about |
| date |
ΣC | 1..1 | dateTime | Composition editing time Constraints: pct-datetime-to-seconds |
| author |
Σ | 1..* | Reference(PCT Organization | PCT Practitioner) | All involved authoring parties, including all Good Faith Estimate (GFE) providers |
| title |
SΣ | 1..1 | string | Human Readable name/title |
| Slices for relatesTo |
0..* | BackboneElement | Relationship to other GFE packets. Required if this estimate is replacing another. Slice: Unordered, Open by value:code | |
| relatesTo:All Slices |
Content/Rules for all slices | |||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| code |
1..1 | code | replaces | transforms | signs | appends Binding: DocumentRelationshipType (required): The type of relationship between documents. | |
| target[x] |
1..1 | Target of the relationship | ||
| targetIdentifier |
Identifier | |||
| targetReference |
Reference(Composition) | |||
| relatesTo:replaces |
S | 0..1 | BackboneElement | The identifier of the document (Composition.identifier) this estimate replaces |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| code |
1..1 | code | replaces | transforms | signs | appends Binding: DocumentRelationshipType (required): The type of relationship between documents. Required Pattern: replaces | |
| Slices for target[x] |
1..1 | Identifier | Target of the relationship Slice: Unordered, Closed by type:$this | |
| target[x]:targetIdentifier |
S | 1..1 | Identifier | Target of the relationship |
| use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| system |
Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
| value |
Σ | 1..1 | string | The value that is unique Example General: 123456 |
| Slices for section |
C | 2..* | BackboneElement | Sections Individual GFE Bundles Slice: Unordered, Open by value:code Constraints: cmp-1, cmp-2 |
| section:All Slices |
Content/Rules for all slices | |||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| section:coverage |
SC | 1..1 | BackboneElement | SHALL have a reference to a PCTCoverage resource, contained within the document bundle Constraints: cmp-1, cmp-2 |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| code |
1..1 | CodeableConcept | Classification of section (recommended) Binding: DocumentSectionCodes (example): Classification of a section of a composition/document. Required Pattern: At least the following | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/davinci-pct/CodeSystem/PCTDocumentSection | |
| version |
0..1 | string | Version of the system - if relevant | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: coverage-section | |
| display |
0..1 | string | Representation defined by the system | |
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |
| text |
0..1 | string | Plain text representation of the concept | |
| entry |
SC | 1..1 | Reference(PCT Coverage) {b} | A reference to data that supports this section |
| section:gfeBundle |
SC | 1..* | BackboneElement | SHALL reference one PCTGFEBundle or PCTGFEMissingBundle resource, which SHALL be contained in the document bundle, and the associated author (GFE Contributor) or proposed author (in the case of a missing GFE Bundle) contained in the document bundle. Constraints: cmp-1, cmp-2 |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| code |
1..1 | CodeableConcept | Classification of section (recommended) Binding: DocumentSectionCodes (example): Classification of a section of a composition/document. Required Pattern: At least the following | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/davinci-pct/CodeSystem/PCTDocumentSection | |
| version |
0..1 | string | Version of the system - if relevant | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: gfe-section | |
| display |
0..1 | string | Representation defined by the system | |
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |
| text |
0..1 | string | Plain text representation of the concept | |
| author |
S | 1..1 | Reference(PCT Practitioner | PCT Organization) {b} | Associated GFE author (GFE Contributor) or proposed author (in the case of a missing GFE Bundle) contained in the document bundle |
| entry |
SC | 1..1 | Reference(PCT GFE Bundle | PCT GFE Missing Bundle) {b} | A reference to data that supports this section |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Composition.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1From the FHIR Standard | |
| Composition.status | required | CompositionStatushttp://hl7.org/fhir/ValueSet/composition-status|4.0.1From the FHIR Standard | |
| Composition.type | preferred | Pattern Value: gfe-packethttp://hl7.org/fhir/ValueSet/doc-typecodesFrom the FHIR Standard | |
| Composition.category | example | DocumentClassValueSethttp://hl7.org/fhir/ValueSet/document-classcodesFrom the FHIR Standard | |
| Composition.category:estimate | example | DocumentClassValueSethttp://hl7.org/fhir/ValueSet/document-classcodesFrom the FHIR Standard | |
| Composition.relatesTo.code | required | DocumentRelationshipTypehttp://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1From the FHIR Standard | |
| Composition.relatesTo:replaces.code | required | Pattern Value: replaceshttp://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1From the FHIR Standard | |
| Composition.relatesTo:replaces.target[x]:targetIdentifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1From the FHIR Standard | |
| Composition.section:coverage.code | example | Pattern Value: coverage-sectionhttp://hl7.org/fhir/ValueSet/doc-section-codesFrom the FHIR Standard | |
| Composition.section:gfeBundle.code | example | Pattern Value: gfe-sectionhttp://hl7.org/fhir/ValueSet/doc-section-codesFrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| cmp-1 | error | Composition.section, Composition.section:coverage, Composition.section:gfeBundle | A section must contain at least one of text, entries, or sub-sections : text.exists() or entry.exists() or section.exists() | |
| cmp-2 | error | Composition.section, Composition.section:coverage, Composition.section:gfeBundle | A section can only have an emptyReason if it is empty : emptyReason.empty() or entry.empty() | |
| dom-2 | error | Composition | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Composition | 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 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(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | Composition | 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 | Composition | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Composition | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| pct-datetime-to-seconds | error | Composition.date | Datetime must be at least to seconds. : $this is dateTime implies $this.toString().length() >= 19 | |
| pct-gfe-packet-composition-1 | error | Composition | Scheduled service requests require a planned period of service : extension.where(url='http://hl7.org/fhir/us/davinci-pct/StructureDefinition/requestOriginationType' and value.ofType(CodeableConcept).coding.where(code='scheduled-request').exists()).exists() implies extension.where(url='http://hl7.org/fhir/us/davinci-pct/StructureDefinition/gfeServiceLinkingInfo' and extension.where(url = 'plannedPeriodOfService').exists()).exists() |
Differential View
This structure is derived from Composition
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Composition |
C | 0..* | Composition | A set of resources composed into a single coherent clinical statement with clinical attestation Constraints: pct-gfe-packet-composition-1 |
| Slices for extension |
2..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:requestInitiationTime |
S | 1..1 | instant | Estimate Request instant (instance service was scheduled or estimate requested) URL: http://hl7.org/fhir/us/davinci-pct/StructureDefinition/requestInitiationTime |
| extension:gfeServiceLinkingInfo |
S | 0..1 | (Complex) | GFE Service Linking Information including planned period of service and a GFE linking identifier. Scheduled services SHALL have a plannedPeriodOfService valueDate or ValuePeriod URL: http://hl7.org/fhir/us/davinci-pct/StructureDefinition/gfeServiceLinkingInfo |
| extension:requestOriginationType |
S | 1..1 | CodeableConcept | Indicator as to whether the request for estimate originated from a scheduled or unscheduled service. URL: http://hl7.org/fhir/us/davinci-pct/StructureDefinition/requestOriginationType Binding: PCT GFE Request Type Codes ValueSet (required) |
| identifier |
1..1 | Identifier | Version-independent identifier for the Composition | |
| system |
1..1 | uri | The namespace for the identifier value | |
| value |
1..1 | string | The value that is unique | |
| type |
1..1 | CodeableConcept | Kind of composition (LOINC if possible) Required Pattern: At least the following | |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/davinci-pct/CodeSystem/PCTDocumentTypeTemporaryTrialUse | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: gfe-packet | |
| Slices for category |
1..* | CodeableConcept | Categorization of Composition Slice: Unordered, Open by value:coding | |
| category:estimate |
S | 1..1 | CodeableConcept | Categorization of Composition |
| Slices for coding |
1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:$this | |
| coding:estimate-coding |
S | 1..1 | Coding | Code defined by a terminology system Required Pattern: At least the following |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/davinci-pct/CodeSystem/PCTDocumentTypeTemporaryTrialUse | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: estimate | |
| subject |
S | 1..1 | Reference(US Core Patient Profile(7.0.0)) | Who and/or what the composition is about |
| date |
C | 1..1 | dateTime | Composition editing time Constraints: pct-datetime-to-seconds |
| author |
1..* | Reference(PCT Organization | PCT Practitioner) | All involved authoring parties, including all Good Faith Estimate (GFE) providers | |
| title |
S | 1..1 | string | Human Readable name/title |
| Slices for relatesTo |
0..* | BackboneElement | Relationship to other GFE packets. Required if this estimate is replacing another. Slice: Unordered, Open by value:code | |
| relatesTo:replaces |
S | 0..1 | BackboneElement | The identifier of the document (Composition.identifier) this estimate replaces |
| code |
1..1 | code | replaces | transforms | signs | appends Required Pattern: replaces | |
| Slices for target[x] |
1..1 | Identifier | Target of the relationship Slice: Unordered, Open by type:$this | |
| target[x]:targetIdentifier |
S | 1..1 | Identifier | Target of the relationship |
| system |
1..1 | uri | The namespace for the identifier value | |
| value |
1..1 | string | The value that is unique | |
| Slices for section |
2..* | BackboneElement | Sections Individual GFE Bundles Slice: Unordered, Open by value:code | |
| section:coverage |
S | 1..1 | BackboneElement | SHALL have a reference to a PCTCoverage resource, contained within the document bundle |
| code |
1..1 | CodeableConcept | Classification of section (recommended) Required Pattern: At least the following | |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/davinci-pct/CodeSystem/PCTDocumentSection | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: coverage-section | |
| entry |
S | 1..1 | Reference(PCT Coverage) {b} | A reference to data that supports this section |
| section:gfeBundle |
S | 1..* | BackboneElement | SHALL reference one PCTGFEBundle or PCTGFEMissingBundle resource, which SHALL be contained in the document bundle, and the associated author (GFE Contributor) or proposed author (in the case of a missing GFE Bundle) contained in the document bundle. |
| code |
1..1 | CodeableConcept | Classification of section (recommended) Required Pattern: At least the following | |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/davinci-pct/CodeSystem/PCTDocumentSection | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: gfe-section | |
| author |
S | 1..1 | Reference(PCT Practitioner | PCT Organization) {b} | Associated GFE author (GFE Contributor) or proposed author (in the case of a missing GFE Bundle) contained in the document bundle |
| entry |
S | 1..1 | Reference(PCT GFE Bundle | PCT GFE Missing Bundle) {b} | A reference to data that supports this section |
| Documentation for this format | ||||
| Id | Grade | Path(s) | Details | Requirements |
| pct-datetime-to-seconds | error | Composition.date | Datetime must be at least to seconds. : $this is dateTime implies $this.toString().length() >= 19 | |
| pct-gfe-packet-composition-1 | error | Composition | Scheduled service requests require a planned period of service : extension.where(url='http://hl7.org/fhir/us/davinci-pct/StructureDefinition/requestOriginationType' and value.ofType(CodeableConcept).coding.where(code='scheduled-request').exists()).exists() implies extension.where(url='http://hl7.org/fhir/us/davinci-pct/StructureDefinition/gfeServiceLinkingInfo' and extension.where(url = 'plannedPeriodOfService').exists()).exists() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Composition |
C | 0..* | Composition | A set of resources composed into a single coherent clinical statement with clinical attestation Constraints: pct-gfe-packet-composition-1 | ||||
| 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 | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| 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 | |||||
| Slices for extension |
2..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:requestInitiationTime |
S | 1..1 | instant | Estimate Request instant (instance service was scheduled or estimate requested) URL: http://hl7.org/fhir/us/davinci-pct/StructureDefinition/requestInitiationTime | ||||
| extension:gfeServiceLinkingInfo |
S | 0..1 | (Complex) | GFE Service Linking Information including planned period of service and a GFE linking identifier. Scheduled services SHALL have a plannedPeriodOfService valueDate or ValuePeriod URL: http://hl7.org/fhir/us/davinci-pct/StructureDefinition/gfeServiceLinkingInfo | ||||
| extension:requestOriginationType |
S | 1..1 | CodeableConcept | Indicator as to whether the request for estimate originated from a scheduled or unscheduled service. URL: http://hl7.org/fhir/us/davinci-pct/StructureDefinition/requestOriginationType Binding: PCT GFE Request Type Codes ValueSet (required) | ||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier |
Σ | 1..1 | Identifier | Version-independent identifier for the Composition | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
| type |
Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
| system |
Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
| value |
Σ | 1..1 | string | The value that is unique Example General: 123456 | ||||
| period |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| status |
?!Σ | 1..1 | code | preliminary | final | amended | entered-in-error Binding: CompositionStatus (required): The workflow/clinical status of the composition. | ||||
| type |
Σ | 1..1 | CodeableConcept | Kind of composition (LOINC if possible) Binding: FHIRDocumentTypeCodes (preferred): Type of a composition. Required Pattern: At least the following | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/davinci-pct/CodeSystem/PCTDocumentTypeTemporaryTrialUse | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: gfe-packet | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| text |
0..1 | string | Plain text representation of the concept | |||||
| Slices for category |
Σ | 1..* | CodeableConcept | Categorization of Composition Slice: Unordered, Open by value:coding Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level. | ||||
| category:estimate |
SΣ | 1..1 | CodeableConcept | Categorization of Composition Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level. | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| Slices for coding |
Σ | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:$this | ||||
| coding:estimate-coding |
SΣ | 1..1 | Coding | Code defined by a terminology system Required Pattern: At least the following | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/davinci-pct/CodeSystem/PCTDocumentTypeTemporaryTrialUse | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: estimate | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| text |
Σ | 0..1 | string | Plain text representation of the concept | ||||
| subject |
SΣ | 1..1 | Reference(US Core Patient Profile(7.0.0)) | Who and/or what the composition is about | ||||
| encounter |
Σ | 0..1 | Reference(Encounter) | Context of the Composition | ||||
| date |
ΣC | 1..1 | dateTime | Composition editing time Constraints: pct-datetime-to-seconds | ||||
| author |
Σ | 1..* | Reference(PCT Organization | PCT Practitioner) | All involved authoring parties, including all Good Faith Estimate (GFE) providers | ||||
| title |
SΣ | 1..1 | string | Human Readable name/title | ||||
| confidentiality |
Σ | 0..1 | code | As defined by affinity domain Binding: v3.ConfidentialityClassification (2014-03-26) (required): Codes specifying the level of confidentiality of the composition. | ||||
| attester |
0..* | BackboneElement | Attests to accuracy of composition | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| mode |
1..1 | code | personal | professional | legal | official Binding: CompositionAttestationMode (required): The way in which a person authenticated a composition. | |||||
| time |
0..1 | dateTime | When the composition was attested | |||||
| party |
0..1 | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole | Organization) | Who attested the composition | |||||
| custodian |
Σ | 0..1 | Reference(Organization) | Organization which maintains the composition | ||||
| Slices for relatesTo |
0..* | BackboneElement | Relationship to other GFE packets. Required if this estimate is replacing another. Slice: Unordered, Open by value:code | |||||
| relatesTo:All Slices |
Content/Rules for all slices | |||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| code |
1..1 | code | replaces | transforms | signs | appends Binding: DocumentRelationshipType (required): The type of relationship between documents. | |||||
| target[x] |
1..1 | Target of the relationship | ||||||
| targetIdentifier |
Identifier | |||||||
| targetReference |
Reference(Composition) | |||||||
| relatesTo:replaces |
S | 0..1 | BackboneElement | The identifier of the document (Composition.identifier) this estimate replaces | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| code |
1..1 | code | replaces | transforms | signs | appends Binding: DocumentRelationshipType (required): The type of relationship between documents. Required Pattern: replaces | |||||
| Slices for target[x] |
1..1 | Identifier | Target of the relationship Slice: Unordered, Closed by type:$this | |||||
| target[x]:targetIdentifier |
S | 1..1 | Identifier | Target of the relationship | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
| type |
Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
| system |
Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
| value |
Σ | 1..1 | string | The value that is unique Example General: 123456 | ||||
| period |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| event |
Σ | 0..* | BackboneElement | The clinical service(s) being documented | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| code |
Σ | 0..* | CodeableConcept | Code(s) that apply to the event being documented Binding: ActCode (3.0.0) (example): This list of codes represents the main clinical acts being documented. | ||||
| period |
Σ | 0..1 | Period | The period covered by the documentation | ||||
| detail |
Σ | 0..* | Reference(Resource) | The event(s) being documented | ||||
| Slices for section |
C | 2..* | BackboneElement | Sections Individual GFE Bundles Slice: Unordered, Open by value:code Constraints: cmp-1, cmp-2 | ||||
| section:All Slices |
Content/Rules for all slices | |||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| title |
0..1 | string | Label for section (e.g. for ToC) | |||||
| code |
0..1 | CodeableConcept | Classification of section (recommended) Binding: DocumentSectionCodes (example): Classification of a section of a composition/document. | |||||
| author |
0..* | Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization) | Who and/or what authored the section | |||||
| focus |
0..1 | Reference(Resource) | Who/what the section is about, when it is not about the subject of composition | |||||
| text |
C | 0..1 | Narrative | Text summary of the section, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | ||||
| mode |
0..1 | code | working | snapshot | changes Binding: ListMode (required): The processing mode that applies to this section. | |||||
| orderedBy |
0..1 | CodeableConcept | Order of section entries Binding: ListOrderCodes (preferred): What order applies to the items in the entry. | |||||
| entry |
C | 0..* | Reference(Resource) | A reference to data that supports this section | ||||
| emptyReason |
C | 0..1 | CodeableConcept | Why the section is empty Binding: ListEmptyReasons (preferred): If a section is empty, why it is empty. | ||||
| section |
C | 0..* | See section (Composition) | Nested Section | ||||
| section:coverage |
SC | 1..1 | BackboneElement | SHALL have a reference to a PCTCoverage resource, contained within the document bundle Constraints: cmp-1, cmp-2 | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| title |
0..1 | string | Label for section (e.g. for ToC) | |||||
| code |
1..1 | CodeableConcept | Classification of section (recommended) Binding: DocumentSectionCodes (example): Classification of a section of a composition/document. Required Pattern: At least the following | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/davinci-pct/CodeSystem/PCTDocumentSection | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: coverage-section | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| text |
0..1 | string | Plain text representation of the concept | |||||
| author |
0..* | Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization) | Who and/or what authored the section | |||||
| focus |
0..1 | Reference(Resource) | Who/what the section is about, when it is not about the subject of composition | |||||
| text |
C | 0..1 | Narrative | Text summary of the section, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | ||||
| mode |
0..1 | code | working | snapshot | changes Binding: ListMode (required): The processing mode that applies to this section. | |||||
| orderedBy |
0..1 | CodeableConcept | Order of section entries Binding: ListOrderCodes (preferred): What order applies to the items in the entry. | |||||
| entry |
SC | 1..1 | Reference(PCT Coverage) {b} | A reference to data that supports this section | ||||
| emptyReason |
C | 0..1 | CodeableConcept | Why the section is empty Binding: ListEmptyReasons (preferred): If a section is empty, why it is empty. | ||||
| section |
C | 0..* | See section (Composition) | Nested Section | ||||
| section:gfeBundle |
SC | 1..* | BackboneElement | SHALL reference one PCTGFEBundle or PCTGFEMissingBundle resource, which SHALL be contained in the document bundle, and the associated author (GFE Contributor) or proposed author (in the case of a missing GFE Bundle) contained in the document bundle. Constraints: cmp-1, cmp-2 | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| title |
0..1 | string | Label for section (e.g. for ToC) | |||||
| code |
1..1 | CodeableConcept | Classification of section (recommended) Binding: DocumentSectionCodes (example): Classification of a section of a composition/document. Required Pattern: At least the following | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/davinci-pct/CodeSystem/PCTDocumentSection | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: gfe-section | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| text |
0..1 | string | Plain text representation of the concept | |||||
| author |
S | 1..1 | Reference(PCT Practitioner | PCT Organization) {b} | Associated GFE author (GFE Contributor) or proposed author (in the case of a missing GFE Bundle) contained in the document bundle | ||||
| focus |
0..1 | Reference(Resource) | Who/what the section is about, when it is not about the subject of composition | |||||
| text |
C | 0..1 | Narrative | Text summary of the section, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | ||||
| mode |
0..1 | code | working | snapshot | changes Binding: ListMode (required): The processing mode that applies to this section. | |||||
| orderedBy |
0..1 | CodeableConcept | Order of section entries Binding: ListOrderCodes (preferred): What order applies to the items in the entry. | |||||
| entry |
SC | 1..1 | Reference(PCT GFE Bundle | PCT GFE Missing Bundle) {b} | A reference to data that supports this section | ||||
| emptyReason |
C | 0..1 | CodeableConcept | Why the section is empty Binding: ListEmptyReasons (preferred): If a section is empty, why it is empty. | ||||
| section |
C | 0..* | See section (Composition) | Nested Section | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| Composition.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesFrom the FHIR Standard
| ||||
| Composition.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1From the FHIR Standard | ||||
| Composition.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-typeFrom the FHIR Standard | ||||
| Composition.status | required | CompositionStatushttp://hl7.org/fhir/ValueSet/composition-status|4.0.1From the FHIR Standard | ||||
| Composition.type | preferred | Pattern Value: gfe-packethttp://hl7.org/fhir/ValueSet/doc-typecodesFrom the FHIR Standard | ||||
| Composition.category | example | DocumentClassValueSethttp://hl7.org/fhir/ValueSet/document-classcodesFrom the FHIR Standard | ||||
| Composition.category:estimate | example | DocumentClassValueSethttp://hl7.org/fhir/ValueSet/document-classcodesFrom the FHIR Standard | ||||
| Composition.confidentiality | required | v3.ConfidentialityClassificationhttp://terminology.hl7.org/ValueSet/v3-ConfidentialityClassification|2014-03-26From the FHIR Standard | ||||
| Composition.attester.mode | required | CompositionAttestationModehttp://hl7.org/fhir/ValueSet/composition-attestation-mode|4.0.1From the FHIR Standard | ||||
| Composition.relatesTo.code | required | DocumentRelationshipTypehttp://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1From the FHIR Standard | ||||
| Composition.relatesTo:replaces.code | required | Pattern Value: replaceshttp://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1From the FHIR Standard | ||||
| Composition.relatesTo:replaces.target[x]:targetIdentifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1From the FHIR Standard | ||||
| Composition.relatesTo:replaces.target[x]:targetIdentifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-typeFrom the FHIR Standard | ||||
| Composition.event.code | example | ActCodehttp://terminology.hl7.org/ValueSet/v3-ActCode|3.0.0 | ||||
| Composition.section.code | example | DocumentSectionCodeshttp://hl7.org/fhir/ValueSet/doc-section-codesFrom the FHIR Standard | ||||
| Composition.section.mode | required | ListModehttp://hl7.org/fhir/ValueSet/list-mode|4.0.1From the FHIR Standard | ||||
| Composition.section.orderedBy | preferred | ListOrderCodeshttp://hl7.org/fhir/ValueSet/list-orderFrom the FHIR Standard | ||||
| Composition.section.emptyReason | preferred | ListEmptyReasonshttp://hl7.org/fhir/ValueSet/list-empty-reasonFrom the FHIR Standard | ||||
| Composition.section:coverage.code | example | Pattern Value: coverage-sectionhttp://hl7.org/fhir/ValueSet/doc-section-codesFrom the FHIR Standard | ||||
| Composition.section:coverage.mode | required | ListModehttp://hl7.org/fhir/ValueSet/list-mode|4.0.1From the FHIR Standard | ||||
| Composition.section:coverage.orderedBy | preferred | ListOrderCodeshttp://hl7.org/fhir/ValueSet/list-orderFrom the FHIR Standard | ||||
| Composition.section:coverage.emptyReason | preferred | ListEmptyReasonshttp://hl7.org/fhir/ValueSet/list-empty-reasonFrom the FHIR Standard | ||||
| Composition.section:gfeBundle.code | example | Pattern Value: gfe-sectionhttp://hl7.org/fhir/ValueSet/doc-section-codesFrom the FHIR Standard | ||||
| Composition.section:gfeBundle.mode | required | ListModehttp://hl7.org/fhir/ValueSet/list-mode|4.0.1From the FHIR Standard | ||||
| Composition.section:gfeBundle.orderedBy | preferred | ListOrderCodeshttp://hl7.org/fhir/ValueSet/list-orderFrom the FHIR Standard | ||||
| Composition.section:gfeBundle.emptyReason | preferred | ListEmptyReasonshttp://hl7.org/fhir/ValueSet/list-empty-reasonFrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| cmp-1 | error | Composition.section, Composition.section:coverage, Composition.section:gfeBundle | A section must contain at least one of text, entries, or sub-sections : text.exists() or entry.exists() or section.exists() | |
| cmp-2 | error | Composition.section, Composition.section:coverage, Composition.section:gfeBundle | A section can only have an emptyReason if it is empty : emptyReason.empty() or entry.empty() | |
| dom-2 | error | Composition | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Composition | 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 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(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | Composition | 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 | Composition | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Composition | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| pct-datetime-to-seconds | error | Composition.date | Datetime must be at least to seconds. : $this is dateTime implies $this.toString().length() >= 19 | |
| pct-gfe-packet-composition-1 | error | Composition | Scheduled service requests require a planned period of service : extension.where(url='http://hl7.org/fhir/us/davinci-pct/StructureDefinition/requestOriginationType' and value.ofType(CodeableConcept).coding.where(code='scheduled-request').exists()).exists() implies extension.where(url='http://hl7.org/fhir/us/davinci-pct/StructureDefinition/gfeServiceLinkingInfo' and extension.where(url = 'plannedPeriodOfService').exists()).exists() |
This structure is derived from Composition
Summary
Mandatory: 17 elements(3 nested mandatory elements)
Must-Support: 14 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Maturity: 1
Other representations of profile: CSV, Excel, Schematron
IG © 2025+ HL7 International / Financial Management. Package hl7.fhir.us.davinci-pct#2.0.0 based on FHIR 4.0.1. Generated 2025-08-27
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change