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-draft 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-documentreference | Version: 2.0.0-draft | |||
Standards status: Trial-use | Maturity Level: 1 | Computable Name: PCTGFEDocumentReference | ||
Other Identifiers: OID:2.16.840.1.113883.4.642.40.4.42.59 |
PCT GFE Packet Document Reference that enables searching and subscriptions for GFE Packets.
Usages:
Changes since version 1.1.0:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
0..* | DocumentReference | A reference to a document | |
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
S | 1..1 | instant | Estimate Request instant URL: http://hl7.org/fhir/us/davinci-pct/StructureDefinition/requestInitiationTime |
![]() ![]() ![]() ![]() |
S | 0..1 | (Complex) | GFE Service Linking Information including planned period of service and a GFE linking identifier URL: http://hl7.org/fhir/us/davinci-pct/StructureDefinition/gfeServiceLinkingInfo |
![]() ![]() ![]() ![]() |
S | 0..* | CodeableConcept | Primary Procedures and/or products involved in the estimates URL: http://hl7.org/fhir/us/davinci-pct/StructureDefinition/estimateProcedureOrService Binding: Claim Medical Product or Service Value Set (required) |
![]() ![]() ![]() ![]() |
S | 0..* | CodeableConcept | Primary diagnoses involved in the estimates URL: http://hl7.org/fhir/us/davinci-pct/StructureDefinition/estimateCondition Binding: PCT ICD-10 Diagnostic Codes (required) |
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() |
SΣ | 0..* | Identifier | Other identifiers for the document |
![]() ![]() ![]() |
?!SΣ | 1..1 | code | current | superseded | entered-in-error Binding: DocumentReferenceStatus (required): The status of the document reference. |
![]() ![]() ![]() |
SΣ | 1..1 | code | preliminary | final | amended | entered-in-error Binding: CompositionStatus (required): Status of the underlying document. |
![]() ![]() ![]() |
SΣ | 1..1 | CodeableConcept | Kind of document (LOINC if possible) Binding: DocumentTypeValueSet (preferred): Precise type of clinical document. Required Pattern: At least the following |
![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/davinci-pct/CodeSystem/PCTDocumentTypeTemporaryTrialUse | |
![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: gfe-packet | |
![]() ![]() ![]() |
SΣ | 1..* | CodeableConcept | (USCDI) Categorization of document Slice: Unordered, Open by value:$this Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level. |
![]() ![]() ![]() ![]() |
Σ | 1..1 | CodeableConcept | Estimate category Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level. Required Pattern: At least the following |
![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/davinci-pct/CodeSystem/PCTDocumentTypeTemporaryTrialUse | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: estimate | |
![]() ![]() ![]() |
SΣ | 1..1 | Reference(HRex Patient Demographics) | Who/what is the subject of the document |
![]() ![]() ![]() |
ΣC | 0..1 | instant | When this document reference was created Constraints: pct-datetime-to-seconds |
![]() ![]() ![]() |
Σ | 1..* | Reference(PCT Organization | PCT Practitioner) | All involved authoring parties, including all Good Faith Estimate (GFE) providers |
![]() ![]() ![]() |
SΣ | 0..* | BackboneElement | Relationship to other GFE packet. Required if this estimate is replacing another. Slice: Unordered, Open by value:code |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | code | replaces | transforms | signs | appends Binding: DocumentRelationshipType (required): The type of relationship between documents. |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | Reference(DocumentReference) | Target of the relationship |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | BackboneElement | Relationship to other GFE packets. Required if this estimate is replacing another. |
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | code | replaces | transforms | signs | appends Binding: DocumentRelationshipType (required): The type of relationship between documents. Required Pattern: replaces |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | Reference(DocumentReference) | Target of the relationship |
![]() ![]() ![]() |
SΣ | 1..1 | BackboneElement | Document referenced |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
SΣC | 1..1 | Attachment | Where to access the document Constraints: pct-dr-1 |
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | code | Mime type of the content, with charset etc. Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. Example General: text/plain; charset=UTF-8, image/png |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | base64Binary | Data inline, base64ed |
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | url | Uri where the data can be found Example General: http://www.acme.com/logo-small.png |
![]() ![]() ![]() ![]() |
Σ | 0..1 | Coding | Format/content rules for the document Binding: DocumentReferenceFormatCodeSet (preferred): Document Format Codes. Required Pattern: At least the following |
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/davinci-pct/CodeSystem/PCTDocumentTypeTemporaryTrialUse | |
![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: pct-gfe-packet | |
![]() |
Path | Conformance | ValueSet / Code | URI |
DocumentReference.status | required | DocumentReferenceStatushttp://hl7.org/fhir/ValueSet/document-reference-status|4.0.1 From the FHIR Standard | |
DocumentReference.docStatus | required | CompositionStatushttp://hl7.org/fhir/ValueSet/composition-status|4.0.1 From the FHIR Standard | |
DocumentReference.type | preferred | Pattern Value: gfe-packethttp://hl7.org/fhir/ValueSet/c80-doc-typecodes From the FHIR Standard | |
DocumentReference.category | example | DocumentClassValueSethttp://hl7.org/fhir/ValueSet/document-classcodes From the FHIR Standard | |
DocumentReference.category:estimate | example | Pattern Value: estimatehttp://hl7.org/fhir/ValueSet/document-classcodes From the FHIR Standard | |
DocumentReference.relatesTo.code | required | DocumentRelationshipTypehttp://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1 From the FHIR Standard | |
DocumentReference.relatesTo:replaces.code | required | Pattern Value: replaceshttp://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1 From the FHIR Standard | |
DocumentReference.content.attachment.contentType | required | Mime Types(a valid code from urn:ietf:bcp:13 )http://hl7.org/fhir/ValueSet/mimetypes|4.0.1 From the FHIR Standard | |
DocumentReference.content.format | preferred | Pattern Value: pct-gfe-packethttp://hl7.org/fhir/ValueSet/formatcodes From the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | DocumentReference | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | DocumentReference | 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 | DocumentReference | 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 | DocumentReference | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | DocumentReference | 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 | DocumentReference.date | Datetime must be at least to seconds. : $this is dateTime implies $this.toString().length() >= 19 | |
pct-dr-1 | error | DocumentReference.content.attachment | DocumentReference.content.attachment.url or DocumentReference.content.attachment.data or both SHALL be present. : url.exists() or data.exists() |
This structure is derived from DocumentReference
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
0..* | DocumentReference | A reference to a document | |
![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
S | 1..1 | instant | Estimate Request instant URL: http://hl7.org/fhir/us/davinci-pct/StructureDefinition/requestInitiationTime |
![]() ![]() ![]() ![]() |
S | 0..1 | (Complex) | GFE Service Linking Information including planned period of service and a GFE linking identifier URL: http://hl7.org/fhir/us/davinci-pct/StructureDefinition/gfeServiceLinkingInfo |
![]() ![]() ![]() ![]() |
S | 0..* | CodeableConcept | Primary Procedures and/or products involved in the estimates URL: http://hl7.org/fhir/us/davinci-pct/StructureDefinition/estimateProcedureOrService Binding: Claim Medical Product or Service Value Set (required) |
![]() ![]() ![]() ![]() |
S | 0..* | CodeableConcept | Primary diagnoses involved in the estimates URL: http://hl7.org/fhir/us/davinci-pct/StructureDefinition/estimateCondition Binding: PCT ICD-10 Diagnostic Codes (required) |
![]() ![]() ![]() |
S | 0..* | Identifier | Other identifiers for the document |
![]() ![]() ![]() |
S | 1..1 | code | current | superseded | entered-in-error |
![]() ![]() ![]() |
S | 1..1 | code | preliminary | final | amended | entered-in-error |
![]() ![]() ![]() |
S | 1..1 | CodeableConcept | Kind of document (LOINC if possible) Required Pattern: At least the following |
![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/davinci-pct/CodeSystem/PCTDocumentTypeTemporaryTrialUse | |
![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: gfe-packet | |
![]() ![]() ![]() |
S | 1..* | CodeableConcept | (USCDI) Categorization of document Slice: Unordered, Open by value:$this |
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Estimate category Required Pattern: At least the following | |
![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/davinci-pct/CodeSystem/PCTDocumentTypeTemporaryTrialUse | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: estimate | |
![]() ![]() ![]() |
S | 1..1 | Reference(HRex Patient Demographics) | Who/what is the subject of the document |
![]() ![]() ![]() |
C | 0..1 | instant | When this document reference was created Constraints: pct-datetime-to-seconds |
![]() ![]() ![]() |
1..* | Reference(PCT Organization | PCT Practitioner) | All involved authoring parties, including all Good Faith Estimate (GFE) providers | |
![]() ![]() ![]() |
S | 0..* | BackboneElement | Relationship to other GFE packet. Required if this estimate is replacing another. Slice: Unordered, Open by value:code |
![]() ![]() ![]() ![]() |
S | 0..1 | BackboneElement | Relationship to other GFE packets. Required if this estimate is replacing another. |
![]() ![]() ![]() ![]() ![]() |
1..1 | code | replaces | transforms | signs | appends Required Pattern: replaces | |
![]() ![]() ![]() |
S | 1..1 | BackboneElement | Document referenced |
![]() ![]() ![]() ![]() |
SC | 1..1 | Attachment | Where to access the document Constraints: pct-dr-1 |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | code | Mime type of the content, with charset etc. |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | base64Binary | Data inline, base64ed |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | url | Uri where the data can be found |
![]() ![]() ![]() ![]() |
0..1 | Coding | Format/content rules for the document Required Pattern: At least the following | |
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/davinci-pct/CodeSystem/PCTDocumentTypeTemporaryTrialUse | |
![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: pct-gfe-packet | |
![]() |
Id | Grade | Path(s) | Details | Requirements |
pct-datetime-to-seconds | error | DocumentReference.date | Datetime must be at least to seconds. : $this is dateTime implies $this.toString().length() >= 19 | |
pct-dr-1 | error | DocumentReference.content.attachment | DocumentReference.content.attachment.url or DocumentReference.content.attachment.data or both SHALL be present. : url.exists() or data.exists() |
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
0..* | DocumentReference | A reference to a document | |||||
![]() ![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
S | 1..1 | instant | Estimate Request instant URL: http://hl7.org/fhir/us/davinci-pct/StructureDefinition/requestInitiationTime | ||||
![]() ![]() ![]() ![]() |
S | 0..1 | (Complex) | GFE Service Linking Information including planned period of service and a GFE linking identifier URL: http://hl7.org/fhir/us/davinci-pct/StructureDefinition/gfeServiceLinkingInfo | ||||
![]() ![]() ![]() ![]() |
S | 0..* | CodeableConcept | Primary Procedures and/or products involved in the estimates URL: http://hl7.org/fhir/us/davinci-pct/StructureDefinition/estimateProcedureOrService Binding: Claim Medical Product or Service Value Set (required) | ||||
![]() ![]() ![]() ![]() |
S | 0..* | CodeableConcept | Primary diagnoses involved in the estimates URL: http://hl7.org/fhir/us/davinci-pct/StructureDefinition/estimateCondition Binding: PCT ICD-10 Diagnostic Codes (required) | ||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
Σ | 0..1 | Identifier | Master Version Specific Identifier | ||||
![]() ![]() ![]() |
SΣ | 0..* | Identifier | Other identifiers for the document | ||||
![]() ![]() ![]() |
?!SΣ | 1..1 | code | current | superseded | entered-in-error Binding: DocumentReferenceStatus (required): The status of the document reference. | ||||
![]() ![]() ![]() |
SΣ | 1..1 | code | preliminary | final | amended | entered-in-error Binding: CompositionStatus (required): Status of the underlying document. | ||||
![]() ![]() ![]() |
SΣ | 1..1 | CodeableConcept | Kind of document (LOINC if possible) Binding: DocumentTypeValueSet (preferred): Precise type of clinical document. Required Pattern: At least the following | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/davinci-pct/CodeSystem/PCTDocumentTypeTemporaryTrialUse | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: gfe-packet | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | |||||
![]() ![]() ![]() |
SΣ | 1..* | CodeableConcept | (USCDI) Categorization of document Slice: Unordered, Open by value:$this Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level. | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | CodeableConcept | Estimate category Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level. Required Pattern: At least the following | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/davinci-pct/CodeSystem/PCTDocumentTypeTemporaryTrialUse | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: estimate | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | |||||
![]() ![]() ![]() |
SΣ | 1..1 | Reference(HRex Patient Demographics) | Who/what is the subject of the document | ||||
![]() ![]() ![]() |
ΣC | 0..1 | instant | When this document reference was created Constraints: pct-datetime-to-seconds | ||||
![]() ![]() ![]() |
Σ | 1..* | Reference(PCT Organization | PCT Practitioner) | All involved authoring parties, including all Good Faith Estimate (GFE) providers | ||||
![]() ![]() ![]() |
0..1 | Reference(Practitioner | PractitionerRole | Organization) | Who/what authenticated the document | |||||
![]() ![]() ![]() |
0..1 | Reference(Organization) | Organization which maintains the document | |||||
![]() ![]() ![]() |
SΣ | 0..* | BackboneElement | Relationship to other GFE packet. Required if this estimate is replacing another. Slice: Unordered, Open by value:code | ||||
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | code | replaces | transforms | signs | appends Binding: DocumentRelationshipType (required): The type of relationship between documents. | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | Reference(DocumentReference) | Target of the relationship | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | BackboneElement | Relationship to other GFE packets. Required if this estimate is replacing another. | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | code | replaces | transforms | signs | appends Binding: DocumentRelationshipType (required): The type of relationship between documents. Required Pattern: replaces | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | Reference(DocumentReference) | Target of the relationship | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Human-readable description | ||||
![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | Document security-tags Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
![]() ![]() ![]() |
SΣ | 1..1 | BackboneElement | Document referenced | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
SΣC | 1..1 | Attachment | Where to access the document Constraints: pct-dr-1 | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | code | Mime type of the content, with charset etc. Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. Example General: text/plain; charset=UTF-8, image/png | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | code | Human language of the content (BCP-47) Binding: CommonLanguages (preferred): A human language.
Example General: en-AU | ||||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | base64Binary | Data inline, base64ed | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | url | Uri where the data can be found Example General: http://www.acme.com/logo-small.png | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | unsignedInt | Number of bytes of content (if url provided) | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | base64Binary | Hash of the data (sha-1, base64ed) | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Label to display in place of the data Example General: Official Corporate Logo | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | dateTime | Date attachment was first created | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Coding | Format/content rules for the document Binding: DocumentReferenceFormatCodeSet (preferred): Document Format Codes. Required Pattern: At least the following | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/davinci-pct/CodeSystem/PCTDocumentTypeTemporaryTrialUse | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: pct-gfe-packet | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |||||
![]() ![]() ![]() |
Σ | 0..1 | BackboneElement | Clinical context of document | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
0..* | Reference(Encounter | EpisodeOfCare) | Context of the document content | |||||
![]() ![]() ![]() ![]() |
0..* | CodeableConcept | Main clinical acts documented Binding: v3 Code System ActCode (example): This list of codes represents the main clinical acts being documented. | |||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time of service that is being documented | ||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Kind of facility where patient was seen Binding: FacilityTypeCodeValueSet (example): XDS Facility Type. | |||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Additional details about where the content was created (e.g. clinical specialty) Binding: PracticeSettingCodeValueSet (example): Additional details about where the content was created (e.g. clinical specialty). | |||||
![]() ![]() ![]() ![]() |
0..1 | Reference(Patient) | Patient demographics from source | |||||
![]() ![]() ![]() ![]() |
0..* | Reference(Resource) | Related identifiers or resources | |||||
![]() |
Path | Conformance | ValueSet / Code | URI | |||
DocumentReference.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages From the FHIR Standard
| ||||
DocumentReference.status | required | DocumentReferenceStatushttp://hl7.org/fhir/ValueSet/document-reference-status|4.0.1 From the FHIR Standard | ||||
DocumentReference.docStatus | required | CompositionStatushttp://hl7.org/fhir/ValueSet/composition-status|4.0.1 From the FHIR Standard | ||||
DocumentReference.type | preferred | Pattern Value: gfe-packethttp://hl7.org/fhir/ValueSet/c80-doc-typecodes From the FHIR Standard | ||||
DocumentReference.category | example | DocumentClassValueSethttp://hl7.org/fhir/ValueSet/document-classcodes From the FHIR Standard | ||||
DocumentReference.category:estimate | example | Pattern Value: estimatehttp://hl7.org/fhir/ValueSet/document-classcodes From the FHIR Standard | ||||
DocumentReference.relatesTo.code | required | DocumentRelationshipTypehttp://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1 From the FHIR Standard | ||||
DocumentReference.relatesTo:replaces.code | required | Pattern Value: replaceshttp://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1 From the FHIR Standard | ||||
DocumentReference.securityLabel | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels From the FHIR Standard | ||||
DocumentReference.content.attachment.contentType | required | Mime Types(a valid code from urn:ietf:bcp:13 )http://hl7.org/fhir/ValueSet/mimetypes|4.0.1 From the FHIR Standard | ||||
DocumentReference.content.attachment.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages From the FHIR Standard
| ||||
DocumentReference.content.format | preferred | Pattern Value: pct-gfe-packethttp://hl7.org/fhir/ValueSet/formatcodes From the FHIR Standard | ||||
DocumentReference.context.event | example | ActCodehttp://terminology.hl7.org/ValueSet/v3-ActCode | ||||
DocumentReference.context.facilityType | example | FacilityTypeCodeValueSethttp://hl7.org/fhir/ValueSet/c80-facilitycodes From the FHIR Standard | ||||
DocumentReference.context.practiceSetting | example | PracticeSettingCodeValueSethttp://hl7.org/fhir/ValueSet/c80-practice-codes From the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | DocumentReference | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | DocumentReference | 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 | DocumentReference | 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 | DocumentReference | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | DocumentReference | 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 | DocumentReference.date | Datetime must be at least to seconds. : $this is dateTime implies $this.toString().length() >= 19 | |
pct-dr-1 | error | DocumentReference.content.attachment | DocumentReference.content.attachment.url or DocumentReference.content.attachment.data or both SHALL be present. : url.exists() or data.exists() |
This structure is derived from DocumentReference
Summary
Mandatory: 8 elements
Must-Support: 17 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: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
0..* | DocumentReference | A reference to a document | |
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
S | 1..1 | instant | Estimate Request instant URL: http://hl7.org/fhir/us/davinci-pct/StructureDefinition/requestInitiationTime |
![]() ![]() ![]() ![]() |
S | 0..1 | (Complex) | GFE Service Linking Information including planned period of service and a GFE linking identifier URL: http://hl7.org/fhir/us/davinci-pct/StructureDefinition/gfeServiceLinkingInfo |
![]() ![]() ![]() ![]() |
S | 0..* | CodeableConcept | Primary Procedures and/or products involved in the estimates URL: http://hl7.org/fhir/us/davinci-pct/StructureDefinition/estimateProcedureOrService Binding: Claim Medical Product or Service Value Set (required) |
![]() ![]() ![]() ![]() |
S | 0..* | CodeableConcept | Primary diagnoses involved in the estimates URL: http://hl7.org/fhir/us/davinci-pct/StructureDefinition/estimateCondition Binding: PCT ICD-10 Diagnostic Codes (required) |
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() |
SΣ | 0..* | Identifier | Other identifiers for the document |
![]() ![]() ![]() |
?!SΣ | 1..1 | code | current | superseded | entered-in-error Binding: DocumentReferenceStatus (required): The status of the document reference. |
![]() ![]() ![]() |
SΣ | 1..1 | code | preliminary | final | amended | entered-in-error Binding: CompositionStatus (required): Status of the underlying document. |
![]() ![]() ![]() |
SΣ | 1..1 | CodeableConcept | Kind of document (LOINC if possible) Binding: DocumentTypeValueSet (preferred): Precise type of clinical document. Required Pattern: At least the following |
![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/davinci-pct/CodeSystem/PCTDocumentTypeTemporaryTrialUse | |
![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: gfe-packet | |
![]() ![]() ![]() |
SΣ | 1..* | CodeableConcept | (USCDI) Categorization of document Slice: Unordered, Open by value:$this Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level. |
![]() ![]() ![]() ![]() |
Σ | 1..1 | CodeableConcept | Estimate category Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level. Required Pattern: At least the following |
![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/davinci-pct/CodeSystem/PCTDocumentTypeTemporaryTrialUse | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: estimate | |
![]() ![]() ![]() |
SΣ | 1..1 | Reference(HRex Patient Demographics) | Who/what is the subject of the document |
![]() ![]() ![]() |
ΣC | 0..1 | instant | When this document reference was created Constraints: pct-datetime-to-seconds |
![]() ![]() ![]() |
Σ | 1..* | Reference(PCT Organization | PCT Practitioner) | All involved authoring parties, including all Good Faith Estimate (GFE) providers |
![]() ![]() ![]() |
SΣ | 0..* | BackboneElement | Relationship to other GFE packet. Required if this estimate is replacing another. Slice: Unordered, Open by value:code |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | code | replaces | transforms | signs | appends Binding: DocumentRelationshipType (required): The type of relationship between documents. |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | Reference(DocumentReference) | Target of the relationship |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | BackboneElement | Relationship to other GFE packets. Required if this estimate is replacing another. |
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | code | replaces | transforms | signs | appends Binding: DocumentRelationshipType (required): The type of relationship between documents. Required Pattern: replaces |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | Reference(DocumentReference) | Target of the relationship |
![]() ![]() ![]() |
SΣ | 1..1 | BackboneElement | Document referenced |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
SΣC | 1..1 | Attachment | Where to access the document Constraints: pct-dr-1 |
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | code | Mime type of the content, with charset etc. Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. Example General: text/plain; charset=UTF-8, image/png |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | base64Binary | Data inline, base64ed |
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | url | Uri where the data can be found Example General: http://www.acme.com/logo-small.png |
![]() ![]() ![]() ![]() |
Σ | 0..1 | Coding | Format/content rules for the document Binding: DocumentReferenceFormatCodeSet (preferred): Document Format Codes. Required Pattern: At least the following |
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/davinci-pct/CodeSystem/PCTDocumentTypeTemporaryTrialUse | |
![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: pct-gfe-packet | |
![]() |
Path | Conformance | ValueSet / Code | URI |
DocumentReference.status | required | DocumentReferenceStatushttp://hl7.org/fhir/ValueSet/document-reference-status|4.0.1 From the FHIR Standard | |
DocumentReference.docStatus | required | CompositionStatushttp://hl7.org/fhir/ValueSet/composition-status|4.0.1 From the FHIR Standard | |
DocumentReference.type | preferred | Pattern Value: gfe-packethttp://hl7.org/fhir/ValueSet/c80-doc-typecodes From the FHIR Standard | |
DocumentReference.category | example | DocumentClassValueSethttp://hl7.org/fhir/ValueSet/document-classcodes From the FHIR Standard | |
DocumentReference.category:estimate | example | Pattern Value: estimatehttp://hl7.org/fhir/ValueSet/document-classcodes From the FHIR Standard | |
DocumentReference.relatesTo.code | required | DocumentRelationshipTypehttp://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1 From the FHIR Standard | |
DocumentReference.relatesTo:replaces.code | required | Pattern Value: replaceshttp://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1 From the FHIR Standard | |
DocumentReference.content.attachment.contentType | required | Mime Types(a valid code from urn:ietf:bcp:13 )http://hl7.org/fhir/ValueSet/mimetypes|4.0.1 From the FHIR Standard | |
DocumentReference.content.format | preferred | Pattern Value: pct-gfe-packethttp://hl7.org/fhir/ValueSet/formatcodes From the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | DocumentReference | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | DocumentReference | 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 | DocumentReference | 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 | DocumentReference | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | DocumentReference | 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 | DocumentReference.date | Datetime must be at least to seconds. : $this is dateTime implies $this.toString().length() >= 19 | |
pct-dr-1 | error | DocumentReference.content.attachment | DocumentReference.content.attachment.url or DocumentReference.content.attachment.data or both SHALL be present. : url.exists() or data.exists() |
Differential View
This structure is derived from DocumentReference
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
0..* | DocumentReference | A reference to a document | |
![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
S | 1..1 | instant | Estimate Request instant URL: http://hl7.org/fhir/us/davinci-pct/StructureDefinition/requestInitiationTime |
![]() ![]() ![]() ![]() |
S | 0..1 | (Complex) | GFE Service Linking Information including planned period of service and a GFE linking identifier URL: http://hl7.org/fhir/us/davinci-pct/StructureDefinition/gfeServiceLinkingInfo |
![]() ![]() ![]() ![]() |
S | 0..* | CodeableConcept | Primary Procedures and/or products involved in the estimates URL: http://hl7.org/fhir/us/davinci-pct/StructureDefinition/estimateProcedureOrService Binding: Claim Medical Product or Service Value Set (required) |
![]() ![]() ![]() ![]() |
S | 0..* | CodeableConcept | Primary diagnoses involved in the estimates URL: http://hl7.org/fhir/us/davinci-pct/StructureDefinition/estimateCondition Binding: PCT ICD-10 Diagnostic Codes (required) |
![]() ![]() ![]() |
S | 0..* | Identifier | Other identifiers for the document |
![]() ![]() ![]() |
S | 1..1 | code | current | superseded | entered-in-error |
![]() ![]() ![]() |
S | 1..1 | code | preliminary | final | amended | entered-in-error |
![]() ![]() ![]() |
S | 1..1 | CodeableConcept | Kind of document (LOINC if possible) Required Pattern: At least the following |
![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/davinci-pct/CodeSystem/PCTDocumentTypeTemporaryTrialUse | |
![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: gfe-packet | |
![]() ![]() ![]() |
S | 1..* | CodeableConcept | (USCDI) Categorization of document Slice: Unordered, Open by value:$this |
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Estimate category Required Pattern: At least the following | |
![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/davinci-pct/CodeSystem/PCTDocumentTypeTemporaryTrialUse | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: estimate | |
![]() ![]() ![]() |
S | 1..1 | Reference(HRex Patient Demographics) | Who/what is the subject of the document |
![]() ![]() ![]() |
C | 0..1 | instant | When this document reference was created Constraints: pct-datetime-to-seconds |
![]() ![]() ![]() |
1..* | Reference(PCT Organization | PCT Practitioner) | All involved authoring parties, including all Good Faith Estimate (GFE) providers | |
![]() ![]() ![]() |
S | 0..* | BackboneElement | Relationship to other GFE packet. Required if this estimate is replacing another. Slice: Unordered, Open by value:code |
![]() ![]() ![]() ![]() |
S | 0..1 | BackboneElement | Relationship to other GFE packets. Required if this estimate is replacing another. |
![]() ![]() ![]() ![]() ![]() |
1..1 | code | replaces | transforms | signs | appends Required Pattern: replaces | |
![]() ![]() ![]() |
S | 1..1 | BackboneElement | Document referenced |
![]() ![]() ![]() ![]() |
SC | 1..1 | Attachment | Where to access the document Constraints: pct-dr-1 |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | code | Mime type of the content, with charset etc. |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | base64Binary | Data inline, base64ed |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | url | Uri where the data can be found |
![]() ![]() ![]() ![]() |
0..1 | Coding | Format/content rules for the document Required Pattern: At least the following | |
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/davinci-pct/CodeSystem/PCTDocumentTypeTemporaryTrialUse | |
![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: pct-gfe-packet | |
![]() |
Id | Grade | Path(s) | Details | Requirements |
pct-datetime-to-seconds | error | DocumentReference.date | Datetime must be at least to seconds. : $this is dateTime implies $this.toString().length() >= 19 | |
pct-dr-1 | error | DocumentReference.content.attachment | DocumentReference.content.attachment.url or DocumentReference.content.attachment.data or both SHALL be present. : url.exists() or data.exists() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
0..* | DocumentReference | A reference to a document | |||||
![]() ![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
S | 1..1 | instant | Estimate Request instant URL: http://hl7.org/fhir/us/davinci-pct/StructureDefinition/requestInitiationTime | ||||
![]() ![]() ![]() ![]() |
S | 0..1 | (Complex) | GFE Service Linking Information including planned period of service and a GFE linking identifier URL: http://hl7.org/fhir/us/davinci-pct/StructureDefinition/gfeServiceLinkingInfo | ||||
![]() ![]() ![]() ![]() |
S | 0..* | CodeableConcept | Primary Procedures and/or products involved in the estimates URL: http://hl7.org/fhir/us/davinci-pct/StructureDefinition/estimateProcedureOrService Binding: Claim Medical Product or Service Value Set (required) | ||||
![]() ![]() ![]() ![]() |
S | 0..* | CodeableConcept | Primary diagnoses involved in the estimates URL: http://hl7.org/fhir/us/davinci-pct/StructureDefinition/estimateCondition Binding: PCT ICD-10 Diagnostic Codes (required) | ||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
Σ | 0..1 | Identifier | Master Version Specific Identifier | ||||
![]() ![]() ![]() |
SΣ | 0..* | Identifier | Other identifiers for the document | ||||
![]() ![]() ![]() |
?!SΣ | 1..1 | code | current | superseded | entered-in-error Binding: DocumentReferenceStatus (required): The status of the document reference. | ||||
![]() ![]() ![]() |
SΣ | 1..1 | code | preliminary | final | amended | entered-in-error Binding: CompositionStatus (required): Status of the underlying document. | ||||
![]() ![]() ![]() |
SΣ | 1..1 | CodeableConcept | Kind of document (LOINC if possible) Binding: DocumentTypeValueSet (preferred): Precise type of clinical document. Required Pattern: At least the following | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/davinci-pct/CodeSystem/PCTDocumentTypeTemporaryTrialUse | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: gfe-packet | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | |||||
![]() ![]() ![]() |
SΣ | 1..* | CodeableConcept | (USCDI) Categorization of document Slice: Unordered, Open by value:$this Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level. | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | CodeableConcept | Estimate category Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level. Required Pattern: At least the following | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/davinci-pct/CodeSystem/PCTDocumentTypeTemporaryTrialUse | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: estimate | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | |||||
![]() ![]() ![]() |
SΣ | 1..1 | Reference(HRex Patient Demographics) | Who/what is the subject of the document | ||||
![]() ![]() ![]() |
ΣC | 0..1 | instant | When this document reference was created Constraints: pct-datetime-to-seconds | ||||
![]() ![]() ![]() |
Σ | 1..* | Reference(PCT Organization | PCT Practitioner) | All involved authoring parties, including all Good Faith Estimate (GFE) providers | ||||
![]() ![]() ![]() |
0..1 | Reference(Practitioner | PractitionerRole | Organization) | Who/what authenticated the document | |||||
![]() ![]() ![]() |
0..1 | Reference(Organization) | Organization which maintains the document | |||||
![]() ![]() ![]() |
SΣ | 0..* | BackboneElement | Relationship to other GFE packet. Required if this estimate is replacing another. Slice: Unordered, Open by value:code | ||||
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | code | replaces | transforms | signs | appends Binding: DocumentRelationshipType (required): The type of relationship between documents. | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | Reference(DocumentReference) | Target of the relationship | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | BackboneElement | Relationship to other GFE packets. Required if this estimate is replacing another. | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | code | replaces | transforms | signs | appends Binding: DocumentRelationshipType (required): The type of relationship between documents. Required Pattern: replaces | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | Reference(DocumentReference) | Target of the relationship | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Human-readable description | ||||
![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | Document security-tags Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
![]() ![]() ![]() |
SΣ | 1..1 | BackboneElement | Document referenced | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
SΣC | 1..1 | Attachment | Where to access the document Constraints: pct-dr-1 | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | code | Mime type of the content, with charset etc. Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. Example General: text/plain; charset=UTF-8, image/png | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | code | Human language of the content (BCP-47) Binding: CommonLanguages (preferred): A human language.
Example General: en-AU | ||||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | base64Binary | Data inline, base64ed | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | url | Uri where the data can be found Example General: http://www.acme.com/logo-small.png | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | unsignedInt | Number of bytes of content (if url provided) | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | base64Binary | Hash of the data (sha-1, base64ed) | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Label to display in place of the data Example General: Official Corporate Logo | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | dateTime | Date attachment was first created | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Coding | Format/content rules for the document Binding: DocumentReferenceFormatCodeSet (preferred): Document Format Codes. Required Pattern: At least the following | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/davinci-pct/CodeSystem/PCTDocumentTypeTemporaryTrialUse | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: pct-gfe-packet | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |||||
![]() ![]() ![]() |
Σ | 0..1 | BackboneElement | Clinical context of document | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
0..* | Reference(Encounter | EpisodeOfCare) | Context of the document content | |||||
![]() ![]() ![]() ![]() |
0..* | CodeableConcept | Main clinical acts documented Binding: v3 Code System ActCode (example): This list of codes represents the main clinical acts being documented. | |||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time of service that is being documented | ||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Kind of facility where patient was seen Binding: FacilityTypeCodeValueSet (example): XDS Facility Type. | |||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Additional details about where the content was created (e.g. clinical specialty) Binding: PracticeSettingCodeValueSet (example): Additional details about where the content was created (e.g. clinical specialty). | |||||
![]() ![]() ![]() ![]() |
0..1 | Reference(Patient) | Patient demographics from source | |||||
![]() ![]() ![]() ![]() |
0..* | Reference(Resource) | Related identifiers or resources | |||||
![]() |
Path | Conformance | ValueSet / Code | URI | |||
DocumentReference.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages From the FHIR Standard
| ||||
DocumentReference.status | required | DocumentReferenceStatushttp://hl7.org/fhir/ValueSet/document-reference-status|4.0.1 From the FHIR Standard | ||||
DocumentReference.docStatus | required | CompositionStatushttp://hl7.org/fhir/ValueSet/composition-status|4.0.1 From the FHIR Standard | ||||
DocumentReference.type | preferred | Pattern Value: gfe-packethttp://hl7.org/fhir/ValueSet/c80-doc-typecodes From the FHIR Standard | ||||
DocumentReference.category | example | DocumentClassValueSethttp://hl7.org/fhir/ValueSet/document-classcodes From the FHIR Standard | ||||
DocumentReference.category:estimate | example | Pattern Value: estimatehttp://hl7.org/fhir/ValueSet/document-classcodes From the FHIR Standard | ||||
DocumentReference.relatesTo.code | required | DocumentRelationshipTypehttp://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1 From the FHIR Standard | ||||
DocumentReference.relatesTo:replaces.code | required | Pattern Value: replaceshttp://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1 From the FHIR Standard | ||||
DocumentReference.securityLabel | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels From the FHIR Standard | ||||
DocumentReference.content.attachment.contentType | required | Mime Types(a valid code from urn:ietf:bcp:13 )http://hl7.org/fhir/ValueSet/mimetypes|4.0.1 From the FHIR Standard | ||||
DocumentReference.content.attachment.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages From the FHIR Standard
| ||||
DocumentReference.content.format | preferred | Pattern Value: pct-gfe-packethttp://hl7.org/fhir/ValueSet/formatcodes From the FHIR Standard | ||||
DocumentReference.context.event | example | ActCodehttp://terminology.hl7.org/ValueSet/v3-ActCode | ||||
DocumentReference.context.facilityType | example | FacilityTypeCodeValueSethttp://hl7.org/fhir/ValueSet/c80-facilitycodes From the FHIR Standard | ||||
DocumentReference.context.practiceSetting | example | PracticeSettingCodeValueSethttp://hl7.org/fhir/ValueSet/c80-practice-codes From the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | DocumentReference | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | DocumentReference | 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 | DocumentReference | 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 | DocumentReference | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | DocumentReference | 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 | DocumentReference.date | Datetime must be at least to seconds. : $this is dateTime implies $this.toString().length() >= 19 | |
pct-dr-1 | error | DocumentReference.content.attachment | DocumentReference.content.attachment.url or DocumentReference.content.attachment.data or both SHALL be present. : url.exists() or data.exists() |
This structure is derived from DocumentReference
Summary
Mandatory: 8 elements
Must-Support: 17 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