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/ASM Version: 0.1.0
Active as of 2024-03-14 Computable Name: ASM

Additional Support Material Profile

Usage:

Formal Views of Profile Content

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

This structure is derived from DocumentReference

NameFlagsCard.TypeDescription & Constraintsdoco
.. DocumentReference 0..*DocumentReferenceA reference to a document
... language S0..1codeLanguage of the resource content
... identifier S1..*IdentifierBusiness identifiers for the document
... version S0..1stringAn explicitly assigned identifer of a variation of the content in the DocumentReference
... modality 0..0
... type S0..1CodeableConceptKind of document (LOINC if possible)
... subject S0..1Reference(Resource)Who/what is the subject of the document
... context S0..*Reference(Appointment | Encounter | EpisodeOfCare)Context of the document content
... bodySite 0..0
... author S0..*Reference(Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson | CareTeam)Who and/or what authored the document
... attester S0..*BackboneElementAttests to accuracy of the document
... custodian S0..1Reference(Organization)Organization which maintains the document
... relatesTo S0..*BackboneElementRelationships to other documents
... description S0..1markdownHuman-readable description
... securityLabel S0..*CodeableConceptDocument security-tags
... content S1..*BackboneElementDocument referenced
.... attachment
..... contentType S0..1codeMime type of the content, with charset etc.
..... language S0..1codeHuman language of the content (BCP-47)

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. DocumentReference C0..*DocumentReferenceA reference to a document
docRef-1: facilityType SHALL only be present if context is not an encounter
docRef-2: practiceSetting SHALL only be present if context is not present
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language S0..1codeLanguage of the resource content
Binding: AllLanguages (required): IETF language tag for a human language

Additional BindingsPurpose
CommonLanguagesStarter Set
... contained 0..*ResourceContained, inline Resources
... identifier SΣ1..*IdentifierBusiness identifiers for the document
... version SΣ0..1stringAn explicitly assigned identifer of a variation of the content in the DocumentReference
... status ?!Σ1..1codecurrent | superseded | entered-in-error
Binding: DocumentReferenceStatus (required): The status of the document reference.

... docStatus SΣ0..1coderegistered | partial | preliminary | final | amended | corrected | appended | cancelled | entered-in-error | deprecated | unknown
Binding: CompositionStatus (required): Status of the underlying document.

... type SΣ0..1CodeableConceptKind of document (LOINC if possible)
Binding: FHIRDocumentTypeCodes (preferred): Precise type of clinical document.

... subject SΣ0..1Reference(Resource)Who/what is the subject of the document
... context SC0..*Reference(Appointment | Encounter | EpisodeOfCare)Context of the document content
... author SΣ0..*Reference(Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson | CareTeam)Who and/or what authored the document
... attester S0..*BackboneElementAttests to accuracy of the document
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... mode 1..1CodeableConceptpersonal | professional | legal | official
Binding: CompositionAttestationMode (preferred): The way in which a person authenticated a document.

... custodian S0..1Reference(Organization)Organization which maintains the document
... relatesTo SΣ0..*BackboneElementRelationships to other documents
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code Σ1..1CodeableConceptThe relationship type with another document
Binding: DocumentRelationshipType (extensible): The type of relationship between the documents.

.... target Σ1..1Reference(DocumentReference)Target of the relationship
... description SΣ0..1markdownHuman-readable description
... securityLabel SΣ0..*CodeableConceptDocument security-tags
Binding: SecurityLabelExamples (example): Example Security Labels from the Healthcare Privacy and Security Classification System.


... content SΣ1..*BackboneElementDocument referenced
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... attachment Σ1..1AttachmentWhere to access the document
..... contentType SΣC0..1codeMime 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Σ0..1codeHuman language of the content (BCP-47)
Binding: AllLanguages (required): IETF language tag for a human language.

Additional BindingsPurpose
CommonLanguagesStarter Set

Example General: en-AU

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
DocumentReference.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
from the FHIR Standard
DocumentReference.statusrequiredDocumentReferenceStatus
http://hl7.org/fhir/ValueSet/document-reference-status|5.0.0
from the FHIR Standard
DocumentReference.docStatusrequiredCompositionStatus
http://hl7.org/fhir/ValueSet/composition-status|5.0.0
from the FHIR Standard
DocumentReference.typepreferredFHIRDocumentTypeCodes
http://hl7.org/fhir/ValueSet/doc-typecodes
from the FHIR Standard
DocumentReference.attester.modepreferredCompositionAttestationMode
http://hl7.org/fhir/ValueSet/composition-attestation-mode
from the FHIR Standard
DocumentReference.relatesTo.codeextensibleDocumentRelationshipType
http://hl7.org/fhir/ValueSet/document-relationship-type
from the FHIR Standard
DocumentReference.securityLabelexampleSecurityLabelExamples
http://hl7.org/fhir/ValueSet/security-label-examples
from the FHIR Standard
DocumentReference.content.attachment.contentTyperequiredMimeTypes (a valid code from urn:ietf:bcp:13)
http://hl7.org/fhir/ValueSet/mimetypes|5.0.0
from the FHIR Standard
DocumentReference.content.attachment.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
from the FHIR Standard
NameFlagsCard.TypeDescription & Constraintsdoco
.. DocumentReference C0..*DocumentReferenceA reference to a document
docRef-1: facilityType SHALL only be present if context is not an encounter
docRef-2: practiceSetting SHALL only be present if context is not present
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language S0..1codeLanguage of the resource content
Binding: AllLanguages (required): IETF language tag for a human language

Additional BindingsPurpose
CommonLanguagesStarter Set
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
... identifier SΣ1..*IdentifierBusiness identifiers for the document
... version SΣ0..1stringAn 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..1codecurrent | superseded | entered-in-error
Binding: DocumentReferenceStatus (required): The status of the document reference.

... docStatus SΣ0..1coderegistered | partial | preliminary | final | amended | corrected | appended | cancelled | entered-in-error | deprecated | unknown
Binding: CompositionStatus (required): Status of the underlying document.

... type SΣ0..1CodeableConceptKind of document (LOINC if possible)
Binding: FHIRDocumentTypeCodes (preferred): Precise type of clinical document.

... category Σ0..*CodeableConceptCategorization of document
Binding: ReferencedItemCategoryValueSet (example): High-level kind of document at a macro level.


... subject SΣ0..1Reference(Resource)Who/what is the subject of the document
... context SC0..*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 C0..1CodeableConceptKind of facility where patient was seen
Binding: FacilityTypeCodeValueSet (example): XDS Facility Type.

... practiceSetting C0..1CodeableConceptAdditional 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..1PeriodTime of service that is being documented
... date Σ0..1instantWhen this document reference was created
... author SΣ0..*Reference(Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson | CareTeam)Who and/or what authored the document
... attester S0..*BackboneElementAttests to accuracy of the document
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... mode 1..1CodeableConceptpersonal | professional | legal | official
Binding: CompositionAttestationMode (preferred): The way in which a person authenticated a document.

.... time 0..1dateTimeWhen the document was attested
.... party 0..1Reference(Patient | RelatedPerson | Practitioner | PractitionerRole | Organization)Who attested the document
... custodian S0..1Reference(Organization)Organization which maintains the document
... relatesTo SΣ0..*BackboneElementRelationships to other documents
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code Σ1..1CodeableConceptThe relationship type with another document
Binding: DocumentRelationshipType (extensible): The type of relationship between the documents.

.... target Σ1..1Reference(DocumentReference)Target of the relationship
... description SΣ0..1markdownHuman-readable description
... securityLabel SΣ0..*CodeableConceptDocument security-tags
Binding: SecurityLabelExamples (example): Example Security Labels from the Healthcare Privacy and Security Classification System.


... content SΣ1..*BackboneElementDocument referenced
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... attachment Σ1..1AttachmentWhere to access the document
..... id 0..1idUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... contentType SΣC0..1codeMime 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Σ0..1codeHuman language of the content (BCP-47)
Binding: AllLanguages (required): IETF language tag for a human language.

Additional BindingsPurpose
CommonLanguagesStarter Set

Example General: en-AU
..... data C0..1base64BinaryData inline, base64ed
..... url Σ0..1urlUri where the data can be found
Example General: http://www.acme.com/logo-small.png
..... size Σ0..1integer64Number of bytes of content (if url provided)
..... hash Σ0..1base64BinaryHash of the data (sha-1, base64ed)
..... title Σ0..1stringLabel to display in place of the data
Example General: Official Corporate Logo
..... creation Σ0..1dateTimeDate attachment was first created
..... height 0..1positiveIntHeight of the image in pixels (photo/video)
..... width 0..1positiveIntWidth of the image in pixels (photo/video)
..... frames 0..1positiveIntNumber of frames if > 1 (photo)
..... duration 0..1decimalLength in seconds (audio / video)
..... pages 0..1positiveIntNumber of printed pages
.... profile Σ0..*BackboneElementContent profile rules for the document
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... value[x] Σ1..1Code|uri|canonical
Binding: HL7 ValueSet of Format Codes for use with Document Sharing (preferred): Document Format Codes.

...... valueCodingCoding
...... valueUriuri
...... valueCanonicalcanonical(Any)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
DocumentReference.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
from the FHIR Standard
DocumentReference.statusrequiredDocumentReferenceStatus
http://hl7.org/fhir/ValueSet/document-reference-status|5.0.0
from the FHIR Standard
DocumentReference.docStatusrequiredCompositionStatus
http://hl7.org/fhir/ValueSet/composition-status|5.0.0
from the FHIR Standard
DocumentReference.typepreferredFHIRDocumentTypeCodes
http://hl7.org/fhir/ValueSet/doc-typecodes
from the FHIR Standard
DocumentReference.categoryexampleReferencedItemCategoryValueSet
http://hl7.org/fhir/ValueSet/referenced-item-category
from the FHIR Standard
DocumentReference.eventexampleActCode
http://terminology.hl7.org/ValueSet/v3-ActCode
DocumentReference.facilityTypeexampleFacilityTypeCodeValueSet
http://hl7.org/fhir/ValueSet/c80-facilitycodes
from the FHIR Standard
DocumentReference.practiceSettingexamplePracticeSettingCodeValueSet
http://hl7.org/fhir/ValueSet/c80-practice-codes
from the FHIR Standard
DocumentReference.attester.modepreferredCompositionAttestationMode
http://hl7.org/fhir/ValueSet/composition-attestation-mode
from the FHIR Standard
DocumentReference.relatesTo.codeextensibleDocumentRelationshipType
http://hl7.org/fhir/ValueSet/document-relationship-type
from the FHIR Standard
DocumentReference.securityLabelexampleSecurityLabelExamples
http://hl7.org/fhir/ValueSet/security-label-examples
from the FHIR Standard
DocumentReference.content.attachment.contentTyperequiredMimeTypes (a valid code from urn:ietf:bcp:13)
http://hl7.org/fhir/ValueSet/mimetypes|5.0.0
from the FHIR Standard
DocumentReference.content.attachment.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
from the FHIR Standard
DocumentReference.content.profile.value[x]preferredHL7FormatCodes
http://terminology.hl7.org/ValueSet/v3-HL7FormatCodes

This structure is derived from DocumentReference

Summary

Mandatory: 1 element
Must-Support: 16 elements
Prohibited: 2 elements

Differential View

This structure is derived from DocumentReference

NameFlagsCard.TypeDescription & Constraintsdoco
.. DocumentReference 0..*DocumentReferenceA reference to a document
... language S0..1codeLanguage of the resource content
... identifier S1..*IdentifierBusiness identifiers for the document
... version S0..1stringAn explicitly assigned identifer of a variation of the content in the DocumentReference
... modality 0..0
... type S0..1CodeableConceptKind of document (LOINC if possible)
... subject S0..1Reference(Resource)Who/what is the subject of the document
... context S0..*Reference(Appointment | Encounter | EpisodeOfCare)Context of the document content
... bodySite 0..0
... author S0..*Reference(Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson | CareTeam)Who and/or what authored the document
... attester S0..*BackboneElementAttests to accuracy of the document
... custodian S0..1Reference(Organization)Organization which maintains the document
... relatesTo S0..*BackboneElementRelationships to other documents
... description S0..1markdownHuman-readable description
... securityLabel S0..*CodeableConceptDocument security-tags
... content S1..*BackboneElementDocument referenced
.... attachment
..... contentType S0..1codeMime type of the content, with charset etc.
..... language S0..1codeHuman language of the content (BCP-47)

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. DocumentReference C0..*DocumentReferenceA reference to a document
docRef-1: facilityType SHALL only be present if context is not an encounter
docRef-2: practiceSetting SHALL only be present if context is not present
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language S0..1codeLanguage of the resource content
Binding: AllLanguages (required): IETF language tag for a human language

Additional BindingsPurpose
CommonLanguagesStarter Set
... contained 0..*ResourceContained, inline Resources
... identifier SΣ1..*IdentifierBusiness identifiers for the document
... version SΣ0..1stringAn explicitly assigned identifer of a variation of the content in the DocumentReference
... status ?!Σ1..1codecurrent | superseded | entered-in-error
Binding: DocumentReferenceStatus (required): The status of the document reference.

... docStatus SΣ0..1coderegistered | partial | preliminary | final | amended | corrected | appended | cancelled | entered-in-error | deprecated | unknown
Binding: CompositionStatus (required): Status of the underlying document.

... type SΣ0..1CodeableConceptKind of document (LOINC if possible)
Binding: FHIRDocumentTypeCodes (preferred): Precise type of clinical document.

... subject SΣ0..1Reference(Resource)Who/what is the subject of the document
... context SC0..*Reference(Appointment | Encounter | EpisodeOfCare)Context of the document content
... author SΣ0..*Reference(Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson | CareTeam)Who and/or what authored the document
... attester S0..*BackboneElementAttests to accuracy of the document
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... mode 1..1CodeableConceptpersonal | professional | legal | official
Binding: CompositionAttestationMode (preferred): The way in which a person authenticated a document.

... custodian S0..1Reference(Organization)Organization which maintains the document
... relatesTo SΣ0..*BackboneElementRelationships to other documents
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code Σ1..1CodeableConceptThe relationship type with another document
Binding: DocumentRelationshipType (extensible): The type of relationship between the documents.

.... target Σ1..1Reference(DocumentReference)Target of the relationship
... description SΣ0..1markdownHuman-readable description
... securityLabel SΣ0..*CodeableConceptDocument security-tags
Binding: SecurityLabelExamples (example): Example Security Labels from the Healthcare Privacy and Security Classification System.


... content SΣ1..*BackboneElementDocument referenced
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... attachment Σ1..1AttachmentWhere to access the document
..... contentType SΣC0..1codeMime 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Σ0..1codeHuman language of the content (BCP-47)
Binding: AllLanguages (required): IETF language tag for a human language.

Additional BindingsPurpose
CommonLanguagesStarter Set

Example General: en-AU

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
DocumentReference.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
from the FHIR Standard
DocumentReference.statusrequiredDocumentReferenceStatus
http://hl7.org/fhir/ValueSet/document-reference-status|5.0.0
from the FHIR Standard
DocumentReference.docStatusrequiredCompositionStatus
http://hl7.org/fhir/ValueSet/composition-status|5.0.0
from the FHIR Standard
DocumentReference.typepreferredFHIRDocumentTypeCodes
http://hl7.org/fhir/ValueSet/doc-typecodes
from the FHIR Standard
DocumentReference.attester.modepreferredCompositionAttestationMode
http://hl7.org/fhir/ValueSet/composition-attestation-mode
from the FHIR Standard
DocumentReference.relatesTo.codeextensibleDocumentRelationshipType
http://hl7.org/fhir/ValueSet/document-relationship-type
from the FHIR Standard
DocumentReference.securityLabelexampleSecurityLabelExamples
http://hl7.org/fhir/ValueSet/security-label-examples
from the FHIR Standard
DocumentReference.content.attachment.contentTyperequiredMimeTypes (a valid code from urn:ietf:bcp:13)
http://hl7.org/fhir/ValueSet/mimetypes|5.0.0
from the FHIR Standard
DocumentReference.content.attachment.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
from the FHIR Standard

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. DocumentReference C0..*DocumentReferenceA reference to a document
docRef-1: facilityType SHALL only be present if context is not an encounter
docRef-2: practiceSetting SHALL only be present if context is not present
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language S0..1codeLanguage of the resource content
Binding: AllLanguages (required): IETF language tag for a human language

Additional BindingsPurpose
CommonLanguagesStarter Set
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
... identifier SΣ1..*IdentifierBusiness identifiers for the document
... version SΣ0..1stringAn 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..1codecurrent | superseded | entered-in-error
Binding: DocumentReferenceStatus (required): The status of the document reference.

... docStatus SΣ0..1coderegistered | partial | preliminary | final | amended | corrected | appended | cancelled | entered-in-error | deprecated | unknown
Binding: CompositionStatus (required): Status of the underlying document.

... type SΣ0..1CodeableConceptKind of document (LOINC if possible)
Binding: FHIRDocumentTypeCodes (preferred): Precise type of clinical document.

... category Σ0..*CodeableConceptCategorization of document
Binding: ReferencedItemCategoryValueSet (example): High-level kind of document at a macro level.


... subject SΣ0..1Reference(Resource)Who/what is the subject of the document
... context SC0..*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 C0..1CodeableConceptKind of facility where patient was seen
Binding: FacilityTypeCodeValueSet (example): XDS Facility Type.

... practiceSetting C0..1CodeableConceptAdditional 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..1PeriodTime of service that is being documented
... date Σ0..1instantWhen this document reference was created
... author SΣ0..*Reference(Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson | CareTeam)Who and/or what authored the document
... attester S0..*BackboneElementAttests to accuracy of the document
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... mode 1..1CodeableConceptpersonal | professional | legal | official
Binding: CompositionAttestationMode (preferred): The way in which a person authenticated a document.

.... time 0..1dateTimeWhen the document was attested
.... party 0..1Reference(Patient | RelatedPerson | Practitioner | PractitionerRole | Organization)Who attested the document
... custodian S0..1Reference(Organization)Organization which maintains the document
... relatesTo SΣ0..*BackboneElementRelationships to other documents
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code Σ1..1CodeableConceptThe relationship type with another document
Binding: DocumentRelationshipType (extensible): The type of relationship between the documents.

.... target Σ1..1Reference(DocumentReference)Target of the relationship
... description SΣ0..1markdownHuman-readable description
... securityLabel SΣ0..*CodeableConceptDocument security-tags
Binding: SecurityLabelExamples (example): Example Security Labels from the Healthcare Privacy and Security Classification System.


... content SΣ1..*BackboneElementDocument referenced
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... attachment Σ1..1AttachmentWhere to access the document
..... id 0..1idUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... contentType SΣC0..1codeMime 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Σ0..1codeHuman language of the content (BCP-47)
Binding: AllLanguages (required): IETF language tag for a human language.

Additional BindingsPurpose
CommonLanguagesStarter Set

Example General: en-AU
..... data C0..1base64BinaryData inline, base64ed
..... url Σ0..1urlUri where the data can be found
Example General: http://www.acme.com/logo-small.png
..... size Σ0..1integer64Number of bytes of content (if url provided)
..... hash Σ0..1base64BinaryHash of the data (sha-1, base64ed)
..... title Σ0..1stringLabel to display in place of the data
Example General: Official Corporate Logo
..... creation Σ0..1dateTimeDate attachment was first created
..... height 0..1positiveIntHeight of the image in pixels (photo/video)
..... width 0..1positiveIntWidth of the image in pixels (photo/video)
..... frames 0..1positiveIntNumber of frames if > 1 (photo)
..... duration 0..1decimalLength in seconds (audio / video)
..... pages 0..1positiveIntNumber of printed pages
.... profile Σ0..*BackboneElementContent profile rules for the document
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... value[x] Σ1..1Code|uri|canonical
Binding: HL7 ValueSet of Format Codes for use with Document Sharing (preferred): Document Format Codes.

...... valueCodingCoding
...... valueUriuri
...... valueCanonicalcanonical(Any)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
DocumentReference.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
from the FHIR Standard
DocumentReference.statusrequiredDocumentReferenceStatus
http://hl7.org/fhir/ValueSet/document-reference-status|5.0.0
from the FHIR Standard
DocumentReference.docStatusrequiredCompositionStatus
http://hl7.org/fhir/ValueSet/composition-status|5.0.0
from the FHIR Standard
DocumentReference.typepreferredFHIRDocumentTypeCodes
http://hl7.org/fhir/ValueSet/doc-typecodes
from the FHIR Standard
DocumentReference.categoryexampleReferencedItemCategoryValueSet
http://hl7.org/fhir/ValueSet/referenced-item-category
from the FHIR Standard
DocumentReference.eventexampleActCode
http://terminology.hl7.org/ValueSet/v3-ActCode
DocumentReference.facilityTypeexampleFacilityTypeCodeValueSet
http://hl7.org/fhir/ValueSet/c80-facilitycodes
from the FHIR Standard
DocumentReference.practiceSettingexamplePracticeSettingCodeValueSet
http://hl7.org/fhir/ValueSet/c80-practice-codes
from the FHIR Standard
DocumentReference.attester.modepreferredCompositionAttestationMode
http://hl7.org/fhir/ValueSet/composition-attestation-mode
from the FHIR Standard
DocumentReference.relatesTo.codeextensibleDocumentRelationshipType
http://hl7.org/fhir/ValueSet/document-relationship-type
from the FHIR Standard
DocumentReference.securityLabelexampleSecurityLabelExamples
http://hl7.org/fhir/ValueSet/security-label-examples
from the FHIR Standard
DocumentReference.content.attachment.contentTyperequiredMimeTypes (a valid code from urn:ietf:bcp:13)
http://hl7.org/fhir/ValueSet/mimetypes|5.0.0
from the FHIR Standard
DocumentReference.content.attachment.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
from the FHIR Standard
DocumentReference.content.profile.value[x]preferredHL7FormatCodes
http://terminology.hl7.org/ValueSet/v3-HL7FormatCodes

This structure is derived from DocumentReference

Summary

Mandatory: 1 element
Must-Support: 16 elements
Prohibited: 2 elements

 

Other representations of profile: CSV, Excel, Schematron