Gravitate Health FHIR Implementation Guide
0.1.0 - CI Build

Gravitate Health FHIR Implementation Guide, published by Gravitate Health Project. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7-eu/gravitate-health/ and changes regularly. See the Directory of published versions

Resource Profile: Additional Support Material Profile

Official URL: http://hl7.eu/fhir/ig/gravitate-health/StructureDefinition/AdditionalSupportMaterial Version: 0.1.0
Active as of 2025-10-13 Computable Name: AdditionalSupportMaterial

Additional Support Material Profile

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. DocumentReference C 0..* DocumentReference A reference to a document
Constraints: docRef-1, docRef-2, gh-docref-1
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language S 0..1 code Language of the resource content
Binding: AllLanguages (required): IETF language tag for a human language
Additional BindingsPurpose
CommonLanguages Starter
... contained 0..* Resource Contained, inline Resources
.... extension:RelatedMedicalIssue 0..* base64Binary, boolean, canonical(), code, date, dateTime, decimal, id, instant, integer, integer64, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, CodeableReference(), Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, RatioRange, Reference(), SampledData, Signature, Timing, ContactDetail, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Availability, ExtendedContactDetail, Dosage, Meta RelatedMedicalIssue - link to condition / disease
URL: http://hl7.eu/fhir/ig/gravitate-health/StructureDefinition/RelatedMedicalIssue
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... identifier SΣ 1..* Identifier Business identifiers for the document
... version SΣ 0..1 string An explicitly assigned identifer of a variation of the content in the DocumentReference
... status ?!Σ 1..1 code current | superseded | entered-in-error
Binding: DocumentReferenceStatus (required): The status of the document reference.
... docStatus SΣ 0..1 code registered | partial | preliminary | final | amended | corrected | appended | cancelled | entered-in-error | deprecated | unknown
Binding: CompositionStatus (required): Status of the underlying document.
... type SΣ 0..1 CodeableConcept Kind of document (LOINC if possible)
Binding: FHIRDocumentTypeCodes (preferred): Precise type of clinical document.
... category SΣ 1..1 CodeableConcept Categorization of document
Binding: ASMCategoryVS (preferred)
... subject SΣ 0..1 Reference(Resource) Who/what is the subject of the document
... context SC 0..* Reference(Appointment | Encounter | EpisodeOfCare) Context of the document content
... author SΣ 1..1 Reference(Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson | CareTeam) Who and/or what authored the document
... attester S 0..* BackboneElement Attests to accuracy of the document
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... mode 1..1 CodeableConcept personal | professional | legal | official
Binding: CompositionAttestationMode (preferred): The way in which a person authenticated a document.
... custodian S 0..1 Reference(Organization) Organization which maintains the document
... relatesTo SΣ 0..* BackboneElement Relationships to other documents
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... code Σ 1..1 CodeableConcept The relationship type with another document
Binding: DocumentRelationshipType (extensible): The type of relationship between the documents.
.... target Σ 1..1 Reference(DocumentReference) Target of the relationship
... description SΣ 0..1 markdown Human-readable description
... securityLabel SΣ 0..* CodeableConcept Document security-tags
Binding: SecurityLabelExamples (example): Example Security Labels from the Healthcare Privacy and Security Classification System.
... content SΣ 1..1 BackboneElement Document referenced
.... Slices for extension S 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:VisualizationMethod 0..1 code VisualizationMethod - how to check the visualization
URL: http://hl7.eu/fhir/ig/gravitate-health/StructureDefinition/VisualizationMethod
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... attachment Σ 1..1 Attachment Where to access the document
..... contentType SΣC 1..1 code Mime type of the content, with charset etc.
Binding: MimeTypes (required): BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049)
Example General: text/plain; charset=UTF-8, image/png
..... language SΣ 1..1 code Human language of the content (BCP-47)
Binding: AllLanguages (required): IETF language tag for a human language.
Additional BindingsPurpose
CommonLanguages Starter

Example General: en-AU
..... data SC 0..1 base64Binary Data inline, base64ed
..... url SΣ 0..1 url Uri where the data can be found
Example General: http://www.acme.com/logo-small.png
..... hash SΣ 0..1 base64Binary Hash of the data (sha-1, base64ed)
..... title SΣ 1..1 string Label to display in place of the data
Example General: Official Corporate Logo
..... creation SΣ 0..1 dateTime Date attachment was first created

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
DocumentReference.language Base required All Languages 📍5.0.0 FHIR Std.
DocumentReference.status Base required DocumentReferenceStatus 📍5.0.0 FHIR Std.
DocumentReference.docStatus Base required Composition Status 📍5.0.0 FHIR Std.
DocumentReference.type Base preferred FHIR Document Type Codes 📍5.0.0 FHIR Std.
DocumentReference.category Base preferred ASMCategoryVS 📦0.1.0 This IG
DocumentReference.attester.​mode Base preferred Composition Attestation Mode 📍5.0.0 FHIR Std.
DocumentReference.relatesTo.​code Base extensible Document Relationship Type 📍5.0.0 FHIR Std.
DocumentReference.securityLabel Base example Example set of Security Labels 📍5.0.0 FHIR Std.
DocumentReference.content.​attachment.contentType Base required Mime Types 📍5.0.0 FHIR Std.
DocumentReference.content.​attachment.language Base required All Languages 📍5.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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()
docRef-1 warning DocumentReference facilityType SHALL only be present if context is not an encounter facilityType.empty() or context.where(resolve() is Encounter).empty()
docRef-2 warning DocumentReference practiceSetting SHALL only be present if context is not present practiceSetting.empty() or context.where(resolve() is Encounter).empty()
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()
gh-docref-1 error DocumentReference A DocumentReference must have either a subject or an extension 'relatedMedicalIssue'. subject.exists() or extension.where(url = 'http://hl7.eu/fhir/ig/gravitate-health/StructureDefinition/RelatedMedicalIssue').exists()

This structure is derived from DocumentReference

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. DocumentReference C 0..* DocumentReference A reference to a document
Constraints: gh-docref-1
... language S 0..1 code Language of the resource content
... Slices for extension S 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:RelatedMedicalIssue 0..* base64Binary, boolean, canonical(), code, date, dateTime, decimal, id, instant, integer, integer64, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, CodeableReference(), Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, RatioRange, Reference(), SampledData, Signature, Timing, ContactDetail, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Availability, ExtendedContactDetail, Dosage, Meta RelatedMedicalIssue - link to condition / disease
URL: http://hl7.eu/fhir/ig/gravitate-health/StructureDefinition/RelatedMedicalIssue
... identifier S 1..* Identifier Business identifiers for the document
... docStatus S 0..1 code registered | partial | preliminary | final | amended | corrected | appended | cancelled | entered-in-error | deprecated | unknown
... modality 0..0
... type S 0..1 CodeableConcept Kind of document (LOINC if possible)
... category S 1..1 CodeableConcept Categorization of document
Binding: ASMCategoryVS (preferred)
... subject S 0..1 Reference(Resource) Who/what is the subject of the document
... context S 0..* Reference(Appointment | Encounter | EpisodeOfCare) Context of the document content
... bodySite 0..0
... author S 1..1 Reference(Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson | CareTeam) Who and/or what authored the document
... attester S 0..* BackboneElement Attests to accuracy of the document
... custodian S 0..1 Reference(Organization) Organization which maintains the document
... relatesTo S 0..* BackboneElement Relationships to other documents
... description S 0..1 markdown Human-readable description
... securityLabel S 0..* CodeableConcept Document security-tags
... content S 1..1 BackboneElement Document referenced
.... Slices for extension S 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:VisualizationMethod 0..1 code VisualizationMethod - how to check the visualization
URL: http://hl7.eu/fhir/ig/gravitate-health/StructureDefinition/VisualizationMethod
.... attachment
..... contentType S 1..1 code Mime type of the content, with charset etc.
..... language S 1..1 code Human language of the content (BCP-47)
..... data S 0..1 base64Binary Data inline, base64ed
..... url S 0..1 url Uri where the data can be found
..... hash S 0..1 base64Binary Hash of the data (sha-1, base64ed)
..... title S 1..1 string Label to display in place of the data
..... creation S 0..1 dateTime Date attachment was first created
.... profile
..... value[x] 1..1 Coding Code|uri|canonical
Binding: TypeOfDataVS (preferred)

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
DocumentReference.category Base preferred ASMCategoryVS 📦0.1.0 This IG
DocumentReference.content.​profile.value[x] Base preferred TypeOfDataVS 📦0.1.0 This IG

Constraints

Id Grade Path(s) Description Expression
gh-docref-1 error DocumentReference A DocumentReference must have either a subject or an extension 'relatedMedicalIssue'. subject.exists() or extension.where(url = 'http://hl7.eu/fhir/ig/gravitate-health/StructureDefinition/RelatedMedicalIssue').exists()
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. DocumentReference C 0..* DocumentReference A reference to a document
Constraints: docRef-1, docRef-2, gh-docref-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 S 0..1 code Language of the resource content
Binding: AllLanguages (required): IETF language tag for a human language
Additional BindingsPurpose
CommonLanguages Starter
... 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 S 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:RelatedMedicalIssue 0..* base64Binary, boolean, canonical(), code, date, dateTime, decimal, id, instant, integer, integer64, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, CodeableReference(), Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, RatioRange, Reference(), SampledData, Signature, Timing, ContactDetail, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Availability, ExtendedContactDetail, Dosage, Meta RelatedMedicalIssue - link to condition / disease
URL: http://hl7.eu/fhir/ig/gravitate-health/StructureDefinition/RelatedMedicalIssue
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... identifier SΣ 1..* Identifier Business identifiers for the document
... version SΣ 0..1 string An explicitly assigned identifer of a variation of the content in the DocumentReference
... basedOn 0..* Reference(Appointment | AppointmentResponse | CarePlan | Claim | CommunicationRequest | Contract | CoverageEligibilityRequest | DeviceRequest | EnrollmentRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | RequestOrchestration | ServiceRequest | SupplyRequest | VisionPrescription) Procedure that caused this media to be created
... status ?!Σ 1..1 code current | superseded | entered-in-error
Binding: DocumentReferenceStatus (required): The status of the document reference.
... docStatus SΣ 0..1 code registered | partial | preliminary | final | amended | corrected | appended | cancelled | entered-in-error | deprecated | unknown
Binding: CompositionStatus (required): Status of the underlying document.
... type SΣ 0..1 CodeableConcept Kind of document (LOINC if possible)
Binding: FHIRDocumentTypeCodes (preferred): Precise type of clinical document.
... category SΣ 1..1 CodeableConcept Categorization of document
Binding: ASMCategoryVS (preferred)
... subject SΣ 0..1 Reference(Resource) Who/what is the subject of the document
... context SC 0..* Reference(Appointment | Encounter | EpisodeOfCare) Context of the document content
... event 0..* CodeableReference() Main clinical acts documented
Binding: v3 Code System ActCode (example): This list of codes represents the main clinical acts being documented.
... facilityType C 0..1 CodeableConcept Kind of facility where patient was seen
Binding: FacilityTypeCodeValueSet (example): XDS Facility Type.
... practiceSetting C 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).
... period Σ 0..1 Period Time of service that is being documented
... date Σ 0..1 instant When this document reference was created
... author SΣ 1..1 Reference(Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson | CareTeam) Who and/or what authored the document
... attester S 0..* BackboneElement Attests to accuracy of the document
.... 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 CodeableConcept personal | professional | legal | official
Binding: CompositionAttestationMode (preferred): The way in which a person authenticated a document.
.... time 0..1 dateTime When the document was attested
.... party 0..1 Reference(Patient | RelatedPerson | Practitioner | PractitionerRole | Organization) Who attested the document
... custodian S 0..1 Reference(Organization) Organization which maintains the document
... relatesTo SΣ 0..* BackboneElement Relationships to other documents
.... 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 CodeableConcept The relationship type with another document
Binding: DocumentRelationshipType (extensible): The type of relationship between the documents.
.... target Σ 1..1 Reference(DocumentReference) Target of the relationship
... description SΣ 0..1 markdown Human-readable description
... securityLabel SΣ 0..* CodeableConcept Document security-tags
Binding: SecurityLabelExamples (example): Example Security Labels from the Healthcare Privacy and Security Classification System.
... content SΣ 1..1 BackboneElement Document referenced
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension S 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:VisualizationMethod 0..1 code VisualizationMethod - how to check the visualization
URL: http://hl7.eu/fhir/ig/gravitate-health/StructureDefinition/VisualizationMethod
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... attachment Σ 1..1 Attachment Where to access the document
..... id 0..1 id Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... contentType SΣC 1..1 code Mime type of the content, with charset etc.
Binding: MimeTypes (required): BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049)
Example General: text/plain; charset=UTF-8, image/png
..... language SΣ 1..1 code Human language of the content (BCP-47)
Binding: AllLanguages (required): IETF language tag for a human language.
Additional BindingsPurpose
CommonLanguages Starter

Example General: en-AU
..... data SC 0..1 base64Binary Data inline, base64ed
..... url SΣ 0..1 url Uri where the data can be found
Example General: http://www.acme.com/logo-small.png
..... size Σ 0..1 integer64 Number of bytes of content (if url provided)
..... hash SΣ 0..1 base64Binary Hash of the data (sha-1, base64ed)
..... title SΣ 1..1 string Label to display in place of the data
Example General: Official Corporate Logo
..... creation SΣ 0..1 dateTime Date attachment was first created
..... height 0..1 positiveInt Height of the image in pixels (photo/video)
..... width 0..1 positiveInt Width of the image in pixels (photo/video)
..... frames 0..1 positiveInt Number of frames if > 1 (photo)
..... duration 0..1 decimal Length in seconds (audio / video)
..... pages 0..1 positiveInt Number of printed pages
.... profile Σ 0..* BackboneElement Content profile rules for the document
..... 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
..... value[x] Σ 1..1 Coding Code|uri|canonical
Binding: TypeOfDataVS (preferred)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
DocumentReference.language Base required All Languages 📍5.0.0 FHIR Std.
DocumentReference.status Base required DocumentReferenceStatus 📍5.0.0 FHIR Std.
DocumentReference.docStatus Base required Composition Status 📍5.0.0 FHIR Std.
DocumentReference.type Base preferred FHIR Document Type Codes 📍5.0.0 FHIR Std.
DocumentReference.category Base preferred ASMCategoryVS 📦0.1.0 This IG
DocumentReference.event Base example v3 Code System ActCode 📦3.0.0 THO v6.5
DocumentReference.facilityType Base example Facility Type Code Value Set 📍5.0.0 FHIR Std.
DocumentReference.practiceSetting Base example Practice Setting Code Value Set 📍5.0.0 FHIR Std.
DocumentReference.attester.​mode Base preferred Composition Attestation Mode 📍5.0.0 FHIR Std.
DocumentReference.relatesTo.​code Base extensible Document Relationship Type 📍5.0.0 FHIR Std.
DocumentReference.securityLabel Base example Example set of Security Labels 📍5.0.0 FHIR Std.
DocumentReference.content.​attachment.contentType Base required Mime Types 📍5.0.0 FHIR Std.
DocumentReference.content.​attachment.language Base required All Languages 📍5.0.0 FHIR Std.
DocumentReference.content.​profile.value[x] Base preferred TypeOfDataVS 📦0.1.0 This IG

Constraints

Id Grade Path(s) Description Expression
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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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()
docRef-1 warning DocumentReference facilityType SHALL only be present if context is not an encounter facilityType.empty() or context.where(resolve() is Encounter).empty()
docRef-2 warning DocumentReference practiceSetting SHALL only be present if context is not present practiceSetting.empty() or context.where(resolve() is Encounter).empty()
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()
gh-docref-1 error DocumentReference A DocumentReference must have either a subject or an extension 'relatedMedicalIssue'. subject.exists() or extension.where(url = 'http://hl7.eu/fhir/ig/gravitate-health/StructureDefinition/RelatedMedicalIssue').exists()

This structure is derived from DocumentReference

Summary

Mandatory: 6 elements
Must-Support: 24 elements
Prohibited: 2 elements

Extensions

This structure refers to these extensions:

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. DocumentReference C 0..* DocumentReference A reference to a document
Constraints: docRef-1, docRef-2, gh-docref-1
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language S 0..1 code Language of the resource content
Binding: AllLanguages (required): IETF language tag for a human language
Additional BindingsPurpose
CommonLanguages Starter
... contained 0..* Resource Contained, inline Resources
.... extension:RelatedMedicalIssue 0..* base64Binary, boolean, canonical(), code, date, dateTime, decimal, id, instant, integer, integer64, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, CodeableReference(), Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, RatioRange, Reference(), SampledData, Signature, Timing, ContactDetail, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Availability, ExtendedContactDetail, Dosage, Meta RelatedMedicalIssue - link to condition / disease
URL: http://hl7.eu/fhir/ig/gravitate-health/StructureDefinition/RelatedMedicalIssue
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... identifier SΣ 1..* Identifier Business identifiers for the document
... version SΣ 0..1 string An explicitly assigned identifer of a variation of the content in the DocumentReference
... status ?!Σ 1..1 code current | superseded | entered-in-error
Binding: DocumentReferenceStatus (required): The status of the document reference.
... docStatus SΣ 0..1 code registered | partial | preliminary | final | amended | corrected | appended | cancelled | entered-in-error | deprecated | unknown
Binding: CompositionStatus (required): Status of the underlying document.
... type SΣ 0..1 CodeableConcept Kind of document (LOINC if possible)
Binding: FHIRDocumentTypeCodes (preferred): Precise type of clinical document.
... category SΣ 1..1 CodeableConcept Categorization of document
Binding: ASMCategoryVS (preferred)
... subject SΣ 0..1 Reference(Resource) Who/what is the subject of the document
... context SC 0..* Reference(Appointment | Encounter | EpisodeOfCare) Context of the document content
... author SΣ 1..1 Reference(Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson | CareTeam) Who and/or what authored the document
... attester S 0..* BackboneElement Attests to accuracy of the document
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... mode 1..1 CodeableConcept personal | professional | legal | official
Binding: CompositionAttestationMode (preferred): The way in which a person authenticated a document.
... custodian S 0..1 Reference(Organization) Organization which maintains the document
... relatesTo SΣ 0..* BackboneElement Relationships to other documents
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... code Σ 1..1 CodeableConcept The relationship type with another document
Binding: DocumentRelationshipType (extensible): The type of relationship between the documents.
.... target Σ 1..1 Reference(DocumentReference) Target of the relationship
... description SΣ 0..1 markdown Human-readable description
... securityLabel SΣ 0..* CodeableConcept Document security-tags
Binding: SecurityLabelExamples (example): Example Security Labels from the Healthcare Privacy and Security Classification System.
... content SΣ 1..1 BackboneElement Document referenced
.... Slices for extension S 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:VisualizationMethod 0..1 code VisualizationMethod - how to check the visualization
URL: http://hl7.eu/fhir/ig/gravitate-health/StructureDefinition/VisualizationMethod
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... attachment Σ 1..1 Attachment Where to access the document
..... contentType SΣC 1..1 code Mime type of the content, with charset etc.
Binding: MimeTypes (required): BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049)
Example General: text/plain; charset=UTF-8, image/png
..... language SΣ 1..1 code Human language of the content (BCP-47)
Binding: AllLanguages (required): IETF language tag for a human language.
Additional BindingsPurpose
CommonLanguages Starter

Example General: en-AU
..... data SC 0..1 base64Binary Data inline, base64ed
..... url SΣ 0..1 url Uri where the data can be found
Example General: http://www.acme.com/logo-small.png
..... hash SΣ 0..1 base64Binary Hash of the data (sha-1, base64ed)
..... title SΣ 1..1 string Label to display in place of the data
Example General: Official Corporate Logo
..... creation SΣ 0..1 dateTime Date attachment was first created

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
DocumentReference.language Base required All Languages 📍5.0.0 FHIR Std.
DocumentReference.status Base required DocumentReferenceStatus 📍5.0.0 FHIR Std.
DocumentReference.docStatus Base required Composition Status 📍5.0.0 FHIR Std.
DocumentReference.type Base preferred FHIR Document Type Codes 📍5.0.0 FHIR Std.
DocumentReference.category Base preferred ASMCategoryVS 📦0.1.0 This IG
DocumentReference.attester.​mode Base preferred Composition Attestation Mode 📍5.0.0 FHIR Std.
DocumentReference.relatesTo.​code Base extensible Document Relationship Type 📍5.0.0 FHIR Std.
DocumentReference.securityLabel Base example Example set of Security Labels 📍5.0.0 FHIR Std.
DocumentReference.content.​attachment.contentType Base required Mime Types 📍5.0.0 FHIR Std.
DocumentReference.content.​attachment.language Base required All Languages 📍5.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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()
docRef-1 warning DocumentReference facilityType SHALL only be present if context is not an encounter facilityType.empty() or context.where(resolve() is Encounter).empty()
docRef-2 warning DocumentReference practiceSetting SHALL only be present if context is not present practiceSetting.empty() or context.where(resolve() is Encounter).empty()
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()
gh-docref-1 error DocumentReference A DocumentReference must have either a subject or an extension 'relatedMedicalIssue'. subject.exists() or extension.where(url = 'http://hl7.eu/fhir/ig/gravitate-health/StructureDefinition/RelatedMedicalIssue').exists()

Differential View

This structure is derived from DocumentReference

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. DocumentReference C 0..* DocumentReference A reference to a document
Constraints: gh-docref-1
... language S 0..1 code Language of the resource content
... Slices for extension S 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:RelatedMedicalIssue 0..* base64Binary, boolean, canonical(), code, date, dateTime, decimal, id, instant, integer, integer64, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, CodeableReference(), Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, RatioRange, Reference(), SampledData, Signature, Timing, ContactDetail, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Availability, ExtendedContactDetail, Dosage, Meta RelatedMedicalIssue - link to condition / disease
URL: http://hl7.eu/fhir/ig/gravitate-health/StructureDefinition/RelatedMedicalIssue
... identifier S 1..* Identifier Business identifiers for the document
... docStatus S 0..1 code registered | partial | preliminary | final | amended | corrected | appended | cancelled | entered-in-error | deprecated | unknown
... modality 0..0
... type S 0..1 CodeableConcept Kind of document (LOINC if possible)
... category S 1..1 CodeableConcept Categorization of document
Binding: ASMCategoryVS (preferred)
... subject S 0..1 Reference(Resource) Who/what is the subject of the document
... context S 0..* Reference(Appointment | Encounter | EpisodeOfCare) Context of the document content
... bodySite 0..0
... author S 1..1 Reference(Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson | CareTeam) Who and/or what authored the document
... attester S 0..* BackboneElement Attests to accuracy of the document
... custodian S 0..1 Reference(Organization) Organization which maintains the document
... relatesTo S 0..* BackboneElement Relationships to other documents
... description S 0..1 markdown Human-readable description
... securityLabel S 0..* CodeableConcept Document security-tags
... content S 1..1 BackboneElement Document referenced
.... Slices for extension S 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:VisualizationMethod 0..1 code VisualizationMethod - how to check the visualization
URL: http://hl7.eu/fhir/ig/gravitate-health/StructureDefinition/VisualizationMethod
.... attachment
..... contentType S 1..1 code Mime type of the content, with charset etc.
..... language S 1..1 code Human language of the content (BCP-47)
..... data S 0..1 base64Binary Data inline, base64ed
..... url S 0..1 url Uri where the data can be found
..... hash S 0..1 base64Binary Hash of the data (sha-1, base64ed)
..... title S 1..1 string Label to display in place of the data
..... creation S 0..1 dateTime Date attachment was first created
.... profile
..... value[x] 1..1 Coding Code|uri|canonical
Binding: TypeOfDataVS (preferred)

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
DocumentReference.category Base preferred ASMCategoryVS 📦0.1.0 This IG
DocumentReference.content.​profile.value[x] Base preferred TypeOfDataVS 📦0.1.0 This IG

Constraints

Id Grade Path(s) Description Expression
gh-docref-1 error DocumentReference A DocumentReference must have either a subject or an extension 'relatedMedicalIssue'. subject.exists() or extension.where(url = 'http://hl7.eu/fhir/ig/gravitate-health/StructureDefinition/RelatedMedicalIssue').exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. DocumentReference C 0..* DocumentReference A reference to a document
Constraints: docRef-1, docRef-2, gh-docref-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 S 0..1 code Language of the resource content
Binding: AllLanguages (required): IETF language tag for a human language
Additional BindingsPurpose
CommonLanguages Starter
... 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 S 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:RelatedMedicalIssue 0..* base64Binary, boolean, canonical(), code, date, dateTime, decimal, id, instant, integer, integer64, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, CodeableReference(), Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, RatioRange, Reference(), SampledData, Signature, Timing, ContactDetail, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Availability, ExtendedContactDetail, Dosage, Meta RelatedMedicalIssue - link to condition / disease
URL: http://hl7.eu/fhir/ig/gravitate-health/StructureDefinition/RelatedMedicalIssue
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... identifier SΣ 1..* Identifier Business identifiers for the document
... version SΣ 0..1 string An explicitly assigned identifer of a variation of the content in the DocumentReference
... basedOn 0..* Reference(Appointment | AppointmentResponse | CarePlan | Claim | CommunicationRequest | Contract | CoverageEligibilityRequest | DeviceRequest | EnrollmentRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | RequestOrchestration | ServiceRequest | SupplyRequest | VisionPrescription) Procedure that caused this media to be created
... status ?!Σ 1..1 code current | superseded | entered-in-error
Binding: DocumentReferenceStatus (required): The status of the document reference.
... docStatus SΣ 0..1 code registered | partial | preliminary | final | amended | corrected | appended | cancelled | entered-in-error | deprecated | unknown
Binding: CompositionStatus (required): Status of the underlying document.
... type SΣ 0..1 CodeableConcept Kind of document (LOINC if possible)
Binding: FHIRDocumentTypeCodes (preferred): Precise type of clinical document.
... category SΣ 1..1 CodeableConcept Categorization of document
Binding: ASMCategoryVS (preferred)
... subject SΣ 0..1 Reference(Resource) Who/what is the subject of the document
... context SC 0..* Reference(Appointment | Encounter | EpisodeOfCare) Context of the document content
... event 0..* CodeableReference() Main clinical acts documented
Binding: v3 Code System ActCode (example): This list of codes represents the main clinical acts being documented.
... facilityType C 0..1 CodeableConcept Kind of facility where patient was seen
Binding: FacilityTypeCodeValueSet (example): XDS Facility Type.
... practiceSetting C 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).
... period Σ 0..1 Period Time of service that is being documented
... date Σ 0..1 instant When this document reference was created
... author SΣ 1..1 Reference(Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson | CareTeam) Who and/or what authored the document
... attester S 0..* BackboneElement Attests to accuracy of the document
.... 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 CodeableConcept personal | professional | legal | official
Binding: CompositionAttestationMode (preferred): The way in which a person authenticated a document.
.... time 0..1 dateTime When the document was attested
.... party 0..1 Reference(Patient | RelatedPerson | Practitioner | PractitionerRole | Organization) Who attested the document
... custodian S 0..1 Reference(Organization) Organization which maintains the document
... relatesTo SΣ 0..* BackboneElement Relationships to other documents
.... 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 CodeableConcept The relationship type with another document
Binding: DocumentRelationshipType (extensible): The type of relationship between the documents.
.... target Σ 1..1 Reference(DocumentReference) Target of the relationship
... description SΣ 0..1 markdown Human-readable description
... securityLabel SΣ 0..* CodeableConcept Document security-tags
Binding: SecurityLabelExamples (example): Example Security Labels from the Healthcare Privacy and Security Classification System.
... content SΣ 1..1 BackboneElement Document referenced
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension S 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:VisualizationMethod 0..1 code VisualizationMethod - how to check the visualization
URL: http://hl7.eu/fhir/ig/gravitate-health/StructureDefinition/VisualizationMethod
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... attachment Σ 1..1 Attachment Where to access the document
..... id 0..1 id Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... contentType SΣC 1..1 code Mime type of the content, with charset etc.
Binding: MimeTypes (required): BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049)
Example General: text/plain; charset=UTF-8, image/png
..... language SΣ 1..1 code Human language of the content (BCP-47)
Binding: AllLanguages (required): IETF language tag for a human language.
Additional BindingsPurpose
CommonLanguages Starter

Example General: en-AU
..... data SC 0..1 base64Binary Data inline, base64ed
..... url SΣ 0..1 url Uri where the data can be found
Example General: http://www.acme.com/logo-small.png
..... size Σ 0..1 integer64 Number of bytes of content (if url provided)
..... hash SΣ 0..1 base64Binary Hash of the data (sha-1, base64ed)
..... title SΣ 1..1 string Label to display in place of the data
Example General: Official Corporate Logo
..... creation SΣ 0..1 dateTime Date attachment was first created
..... height 0..1 positiveInt Height of the image in pixels (photo/video)
..... width 0..1 positiveInt Width of the image in pixels (photo/video)
..... frames 0..1 positiveInt Number of frames if > 1 (photo)
..... duration 0..1 decimal Length in seconds (audio / video)
..... pages 0..1 positiveInt Number of printed pages
.... profile Σ 0..* BackboneElement Content profile rules for the document
..... 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
..... value[x] Σ 1..1 Coding Code|uri|canonical
Binding: TypeOfDataVS (preferred)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
DocumentReference.language Base required All Languages 📍5.0.0 FHIR Std.
DocumentReference.status Base required DocumentReferenceStatus 📍5.0.0 FHIR Std.
DocumentReference.docStatus Base required Composition Status 📍5.0.0 FHIR Std.
DocumentReference.type Base preferred FHIR Document Type Codes 📍5.0.0 FHIR Std.
DocumentReference.category Base preferred ASMCategoryVS 📦0.1.0 This IG
DocumentReference.event Base example v3 Code System ActCode 📦3.0.0 THO v6.5
DocumentReference.facilityType Base example Facility Type Code Value Set 📍5.0.0 FHIR Std.
DocumentReference.practiceSetting Base example Practice Setting Code Value Set 📍5.0.0 FHIR Std.
DocumentReference.attester.​mode Base preferred Composition Attestation Mode 📍5.0.0 FHIR Std.
DocumentReference.relatesTo.​code Base extensible Document Relationship Type 📍5.0.0 FHIR Std.
DocumentReference.securityLabel Base example Example set of Security Labels 📍5.0.0 FHIR Std.
DocumentReference.content.​attachment.contentType Base required Mime Types 📍5.0.0 FHIR Std.
DocumentReference.content.​attachment.language Base required All Languages 📍5.0.0 FHIR Std.
DocumentReference.content.​profile.value[x] Base preferred TypeOfDataVS 📦0.1.0 This IG

Constraints

Id Grade Path(s) Description Expression
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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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()
docRef-1 warning DocumentReference facilityType SHALL only be present if context is not an encounter facilityType.empty() or context.where(resolve() is Encounter).empty()
docRef-2 warning DocumentReference practiceSetting SHALL only be present if context is not present practiceSetting.empty() or context.where(resolve() is Encounter).empty()
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()
gh-docref-1 error DocumentReference A DocumentReference must have either a subject or an extension 'relatedMedicalIssue'. subject.exists() or extension.where(url = 'http://hl7.eu/fhir/ig/gravitate-health/StructureDefinition/RelatedMedicalIssue').exists()

This structure is derived from DocumentReference

Summary

Mandatory: 6 elements
Must-Support: 24 elements
Prohibited: 2 elements

Extensions

This structure refers to these extensions:

 

Other representations of profile: CSV, Excel, Schematron