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
| Official URL: http://hl7.eu/fhir/ig/gravitate-health/StructureDefinition/ASM | Version: 0.1.0 | |||
| Active as of 2024-01-21 | Computable Name: ASM | |||
Additional Support Material Profile
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from DocumentReference
| Name | Flags | Card. | Type | Description & Constraints![]() |
|---|---|---|---|---|
![]() | 0..* | DocumentReference | A reference to a document | |
![]() ![]() | S | 0..1 | code | Language of the resource content |
![]() ![]() | S | 1..* | Identifier | Business identifiers for the document |
![]() ![]() | S | 0..1 | string | An explicitly assigned identifer of a variation of the content in the DocumentReference |
![]() ![]() | S | 0..1 | code | registered | partial | preliminary | final | amended | corrected | appended | cancelled | entered-in-error | deprecated | unknown |
![]() ![]() | 0..0 | |||
![]() ![]() | S | 0..1 | CodeableConcept | Kind of document (LOINC if possible) |
![]() ![]() | S | 0..1 | Reference(Resource) | Who/what is the subject of the document |
![]() ![]() | S | 0..* | Reference(Appointment | Encounter | EpisodeOfCare) | Context of the document content |
![]() ![]() | 0..0 | |||
![]() ![]() | S | 0..* | Reference(Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson | CareTeam) | Who and/or what authored the document |
![]() ![]() | S | 0..* | BackboneElement | Attests to accuracy of the document |
![]() ![]() | S | 0..1 | Reference(Organization) | Organization which maintains the document |
![]() ![]() | S | 0..* | BackboneElement | Relationships to other documents |
![]() ![]() | S | 0..1 | markdown | Human-readable description |
![]() ![]() | S | 0..* | CodeableConcept | Document security-tags |
![]() ![]() | S | 1..* | BackboneElement | Document referenced |
![]() ![]() ![]() | ||||
![]() ![]() ![]() ![]() | S | 0..1 | code | Mime type of the content, with charset etc. |
![]() ![]() ![]() ![]() | S | 0..1 | code | Human language of the content (BCP-47) |
Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() | C | 0..* | DocumentReference | A reference to a document | ||||
![]() ![]() | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() | S | 0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language
| ||||
![]() ![]() | 0..* | Resource | Contained, inline Resources | |||||
![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() | SΣ | 1..* | Identifier | Business identifiers for the document | ||||
![]() ![]() | SΣ | 0..1 | string | An explicitly assigned identifer of a variation of the content in the DocumentReference | ||||
![]() ![]() | ?!Σ | 1..1 | code | current | superseded | entered-in-error Binding: DocumentReferenceStatus (required): The status of the document reference. | ||||
![]() ![]() | 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. | ||||
![]() ![]() | SΣ | 0..1 | CodeableConcept | Kind of document (LOINC if possible) Binding: FHIRDocumentTypeCodes (preferred): Precise type of clinical document. | ||||
![]() ![]() | SΣ | 0..1 | Reference(Resource) | Who/what is the subject of the document | ||||
![]() ![]() | SC | 0..* | Reference(Appointment | Encounter | EpisodeOfCare) | Context of the document content | ||||
![]() ![]() | SΣ | 0..* | Reference(Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson | CareTeam) | Who and/or what authored the document | ||||
![]() ![]() | S | 0..* | BackboneElement | Attests to accuracy of the document | ||||
![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() | 1..1 | CodeableConcept | personal | professional | legal | official Binding: CompositionAttestationMode (preferred): The way in which a person authenticated a document. | |||||
![]() ![]() | S | 0..1 | Reference(Organization) | Organization which maintains the document | ||||
![]() ![]() | SΣ | 0..* | BackboneElement | Relationships to other documents | ||||
![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() | Σ | 1..1 | CodeableConcept | The relationship type with another document Binding: DocumentRelationshipType (extensible): The type of relationship between the documents. | ||||
![]() ![]() ![]() | Σ | 1..1 | Reference(DocumentReference) | Target of the relationship | ||||
![]() ![]() | SΣ | 0..1 | markdown | Human-readable description | ||||
![]() ![]() | SΣ | 0..* | CodeableConcept | Document security-tags Binding: SecurityLabelExamples (example): Example Security Labels from the Healthcare Privacy and Security Classification System. | ||||
![]() ![]() | SΣ | 1..* | BackboneElement | Document referenced | ||||
![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() | Σ | 1..1 | Attachment | Where to access the document | ||||
![]() ![]() ![]() ![]() | SΣC | 0..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 | ||||
![]() ![]() ![]() ![]() | SΣ | 0..1 | code | Human language of the content (BCP-47) Binding: AllLanguages (required): IETF language tag for a human language.
Example General: en-AU | ||||
Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI |
| DocumentReference.language | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages|5.0.0from the FHIR Standard | |
| DocumentReference.status | required | DocumentReferenceStatushttp://hl7.org/fhir/ValueSet/document-reference-status|5.0.0from the FHIR Standard | |
| DocumentReference.docStatus | required | CompositionStatushttp://hl7.org/fhir/ValueSet/composition-status|5.0.0from the FHIR Standard | |
| DocumentReference.type | preferred | FHIRDocumentTypeCodeshttp://hl7.org/fhir/ValueSet/doc-typecodesfrom the FHIR Standard | |
| DocumentReference.attester.mode | preferred | CompositionAttestationModehttp://hl7.org/fhir/ValueSet/composition-attestation-modefrom the FHIR Standard | |
| DocumentReference.relatesTo.code | extensible | DocumentRelationshipTypehttp://hl7.org/fhir/ValueSet/document-relationship-typefrom the FHIR Standard | |
| DocumentReference.securityLabel | example | SecurityLabelExampleshttp://hl7.org/fhir/ValueSet/security-label-examplesfrom the FHIR Standard | |
| DocumentReference.content.attachment.contentType | required | MimeTypes (a valid code from urn:ietf:bcp:13)http://hl7.org/fhir/ValueSet/mimetypes|5.0.0from the FHIR Standard | |
| DocumentReference.content.attachment.language | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages|5.0.0from the FHIR Standard |
| Name | Flags | Card. | Type | Description & Constraints![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() | C | 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 | ||||
![]() ![]() | S | 0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language
| ||||
![]() ![]() | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
![]() ![]() | 0..* | Resource | Contained, inline Resources | |||||
![]() ![]() | 0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() | SΣ | 1..* | Identifier | Business identifiers for the document | ||||
![]() ![]() | SΣ | 0..1 | string | An explicitly assigned identifer of a variation of the content in the DocumentReference | ||||
![]() ![]() | 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 | |||||
![]() ![]() | ?!Σ | 1..1 | code | current | superseded | entered-in-error Binding: DocumentReferenceStatus (required): The status of the document reference. | ||||
![]() ![]() | 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. | ||||
![]() ![]() | SΣ | 0..1 | CodeableConcept | Kind of document (LOINC if possible) Binding: FHIRDocumentTypeCodes (preferred): Precise type of clinical document. | ||||
![]() ![]() | Σ | 0..* | CodeableConcept | Categorization of document Binding: ReferencedItemCategoryValueSet (example): High-level kind of document at a macro level. | ||||
![]() ![]() | SΣ | 0..1 | Reference(Resource) | Who/what is the subject of the document | ||||
![]() ![]() | SC | 0..* | Reference(Appointment | Encounter | EpisodeOfCare) | Context of the document content | ||||
![]() ![]() | 0..* | CodeableReference() | Main clinical acts documented Binding: v3 Code System ActCode (example): This list of codes represents the main clinical acts being documented. | |||||
![]() ![]() | C | 0..1 | CodeableConcept | Kind of facility where patient was seen Binding: FacilityTypeCodeValueSet (example): XDS Facility Type. | ||||
![]() ![]() | 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). | ||||
![]() ![]() | Σ | 0..1 | Period | Time of service that is being documented | ||||
![]() ![]() | Σ | 0..1 | instant | When this document reference was created | ||||
![]() ![]() | SΣ | 0..* | Reference(Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson | CareTeam) | Who and/or what authored the document | ||||
![]() ![]() | S | 0..* | BackboneElement | Attests to accuracy of the 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 | ||||
![]() ![]() ![]() | 1..1 | CodeableConcept | personal | professional | legal | official Binding: CompositionAttestationMode (preferred): The way in which a person authenticated a document. | |||||
![]() ![]() ![]() | 0..1 | dateTime | When the document was attested | |||||
![]() ![]() ![]() | 0..1 | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole | Organization) | Who attested the document | |||||
![]() ![]() | S | 0..1 | Reference(Organization) | Organization which maintains the document | ||||
![]() ![]() | SΣ | 0..* | BackboneElement | Relationships to other documents | ||||
![]() ![]() ![]() | 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 | CodeableConcept | The relationship type with another document Binding: DocumentRelationshipType (extensible): The type of relationship between the documents. | ||||
![]() ![]() ![]() | Σ | 1..1 | Reference(DocumentReference) | Target of the relationship | ||||
![]() ![]() | SΣ | 0..1 | markdown | Human-readable description | ||||
![]() ![]() | SΣ | 0..* | CodeableConcept | Document security-tags Binding: SecurityLabelExamples (example): Example Security Labels from the Healthcare Privacy and Security Classification System. | ||||
![]() ![]() | SΣ | 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 | ||||
![]() ![]() ![]() | Σ | 1..1 | Attachment | Where to access the document | ||||
![]() ![]() ![]() ![]() | 0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() | SΣC | 0..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 | ||||
![]() ![]() ![]() ![]() | SΣ | 0..1 | code | Human language of the content (BCP-47) Binding: AllLanguages (required): IETF language tag for a human language.
Example General: en-AU | ||||
![]() ![]() ![]() ![]() | C | 0..1 | base64Binary | Data inline, base64ed | ||||
![]() ![]() ![]() ![]() | Σ | 0..1 | url | Uri where the data can be found Example General: http://www.acme.com/logo-small.png | ||||
![]() ![]() ![]() ![]() | Σ | 0..1 | integer64 | 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 | positiveInt | Height of the image in pixels (photo/video) | |||||
![]() ![]() ![]() ![]() | 0..1 | positiveInt | Width of the image in pixels (photo/video) | |||||
![]() ![]() ![]() ![]() | 0..1 | positiveInt | Number of frames if > 1 (photo) | |||||
![]() ![]() ![]() ![]() | 0..1 | decimal | Length in seconds (audio / video) | |||||
![]() ![]() ![]() ![]() | 0..1 | positiveInt | Number of printed pages | |||||
![]() ![]() ![]() | Σ | 0..* | BackboneElement | Content profile rules for the 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 | ||||
![]() ![]() ![]() ![]() | Σ | 1..1 | Code|uri|canonical Binding: HL7 ValueSet of Format Codes for use with Document Sharing (preferred): Document Format Codes. | |||||
![]() ![]() ![]() ![]() ![]() | Coding | |||||||
![]() ![]() ![]() ![]() ![]() | uri | |||||||
![]() ![]() ![]() ![]() ![]() | canonical(Any) | |||||||
Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI |
| DocumentReference.language | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages|5.0.0from the FHIR Standard | |
| DocumentReference.status | required | DocumentReferenceStatushttp://hl7.org/fhir/ValueSet/document-reference-status|5.0.0from the FHIR Standard | |
| DocumentReference.docStatus | required | CompositionStatushttp://hl7.org/fhir/ValueSet/composition-status|5.0.0from the FHIR Standard | |
| DocumentReference.type | preferred | FHIRDocumentTypeCodeshttp://hl7.org/fhir/ValueSet/doc-typecodesfrom the FHIR Standard | |
| DocumentReference.category | example | ReferencedItemCategoryValueSethttp://hl7.org/fhir/ValueSet/referenced-item-categoryfrom the FHIR Standard | |
| DocumentReference.event | example | ActCodehttp://terminology.hl7.org/ValueSet/v3-ActCode | |
| DocumentReference.facilityType | example | FacilityTypeCodeValueSethttp://hl7.org/fhir/ValueSet/c80-facilitycodesfrom the FHIR Standard | |
| DocumentReference.practiceSetting | example | PracticeSettingCodeValueSethttp://hl7.org/fhir/ValueSet/c80-practice-codesfrom the FHIR Standard | |
| DocumentReference.attester.mode | preferred | CompositionAttestationModehttp://hl7.org/fhir/ValueSet/composition-attestation-modefrom the FHIR Standard | |
| DocumentReference.relatesTo.code | extensible | DocumentRelationshipTypehttp://hl7.org/fhir/ValueSet/document-relationship-typefrom the FHIR Standard | |
| DocumentReference.securityLabel | example | SecurityLabelExampleshttp://hl7.org/fhir/ValueSet/security-label-examplesfrom the FHIR Standard | |
| DocumentReference.content.attachment.contentType | required | MimeTypes (a valid code from urn:ietf:bcp:13)http://hl7.org/fhir/ValueSet/mimetypes|5.0.0from the FHIR Standard | |
| DocumentReference.content.attachment.language | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages|5.0.0from the FHIR Standard | |
| DocumentReference.content.profile.value[x] | preferred | HL7FormatCodeshttp://terminology.hl7.org/ValueSet/v3-HL7FormatCodes |
This structure is derived from DocumentReference
Differential View
This structure is derived from DocumentReference
| Name | Flags | Card. | Type | Description & Constraints![]() |
|---|---|---|---|---|
![]() | 0..* | DocumentReference | A reference to a document | |
![]() ![]() | S | 0..1 | code | Language of the resource content |
![]() ![]() | S | 1..* | Identifier | Business identifiers for the document |
![]() ![]() | S | 0..1 | string | An explicitly assigned identifer of a variation of the content in the DocumentReference |
![]() ![]() | S | 0..1 | code | registered | partial | preliminary | final | amended | corrected | appended | cancelled | entered-in-error | deprecated | unknown |
![]() ![]() | 0..0 | |||
![]() ![]() | S | 0..1 | CodeableConcept | Kind of document (LOINC if possible) |
![]() ![]() | S | 0..1 | Reference(Resource) | Who/what is the subject of the document |
![]() ![]() | S | 0..* | Reference(Appointment | Encounter | EpisodeOfCare) | Context of the document content |
![]() ![]() | 0..0 | |||
![]() ![]() | S | 0..* | Reference(Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson | CareTeam) | Who and/or what authored the document |
![]() ![]() | S | 0..* | BackboneElement | Attests to accuracy of the document |
![]() ![]() | S | 0..1 | Reference(Organization) | Organization which maintains the document |
![]() ![]() | S | 0..* | BackboneElement | Relationships to other documents |
![]() ![]() | S | 0..1 | markdown | Human-readable description |
![]() ![]() | S | 0..* | CodeableConcept | Document security-tags |
![]() ![]() | S | 1..* | BackboneElement | Document referenced |
![]() ![]() ![]() | ||||
![]() ![]() ![]() ![]() | S | 0..1 | code | Mime type of the content, with charset etc. |
![]() ![]() ![]() ![]() | S | 0..1 | code | Human language of the content (BCP-47) |
Documentation for this format | ||||
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() | C | 0..* | DocumentReference | A reference to a document | ||||
![]() ![]() | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() | S | 0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language
| ||||
![]() ![]() | 0..* | Resource | Contained, inline Resources | |||||
![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() | SΣ | 1..* | Identifier | Business identifiers for the document | ||||
![]() ![]() | SΣ | 0..1 | string | An explicitly assigned identifer of a variation of the content in the DocumentReference | ||||
![]() ![]() | ?!Σ | 1..1 | code | current | superseded | entered-in-error Binding: DocumentReferenceStatus (required): The status of the document reference. | ||||
![]() ![]() | 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. | ||||
![]() ![]() | SΣ | 0..1 | CodeableConcept | Kind of document (LOINC if possible) Binding: FHIRDocumentTypeCodes (preferred): Precise type of clinical document. | ||||
![]() ![]() | SΣ | 0..1 | Reference(Resource) | Who/what is the subject of the document | ||||
![]() ![]() | SC | 0..* | Reference(Appointment | Encounter | EpisodeOfCare) | Context of the document content | ||||
![]() ![]() | SΣ | 0..* | Reference(Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson | CareTeam) | Who and/or what authored the document | ||||
![]() ![]() | S | 0..* | BackboneElement | Attests to accuracy of the document | ||||
![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() | 1..1 | CodeableConcept | personal | professional | legal | official Binding: CompositionAttestationMode (preferred): The way in which a person authenticated a document. | |||||
![]() ![]() | S | 0..1 | Reference(Organization) | Organization which maintains the document | ||||
![]() ![]() | SΣ | 0..* | BackboneElement | Relationships to other documents | ||||
![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() | Σ | 1..1 | CodeableConcept | The relationship type with another document Binding: DocumentRelationshipType (extensible): The type of relationship between the documents. | ||||
![]() ![]() ![]() | Σ | 1..1 | Reference(DocumentReference) | Target of the relationship | ||||
![]() ![]() | SΣ | 0..1 | markdown | Human-readable description | ||||
![]() ![]() | SΣ | 0..* | CodeableConcept | Document security-tags Binding: SecurityLabelExamples (example): Example Security Labels from the Healthcare Privacy and Security Classification System. | ||||
![]() ![]() | SΣ | 1..* | BackboneElement | Document referenced | ||||
![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() | Σ | 1..1 | Attachment | Where to access the document | ||||
![]() ![]() ![]() ![]() | SΣC | 0..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 | ||||
![]() ![]() ![]() ![]() | SΣ | 0..1 | code | Human language of the content (BCP-47) Binding: AllLanguages (required): IETF language tag for a human language.
Example General: en-AU | ||||
Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI |
| DocumentReference.language | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages|5.0.0from the FHIR Standard | |
| DocumentReference.status | required | DocumentReferenceStatushttp://hl7.org/fhir/ValueSet/document-reference-status|5.0.0from the FHIR Standard | |
| DocumentReference.docStatus | required | CompositionStatushttp://hl7.org/fhir/ValueSet/composition-status|5.0.0from the FHIR Standard | |
| DocumentReference.type | preferred | FHIRDocumentTypeCodeshttp://hl7.org/fhir/ValueSet/doc-typecodesfrom the FHIR Standard | |
| DocumentReference.attester.mode | preferred | CompositionAttestationModehttp://hl7.org/fhir/ValueSet/composition-attestation-modefrom the FHIR Standard | |
| DocumentReference.relatesTo.code | extensible | DocumentRelationshipTypehttp://hl7.org/fhir/ValueSet/document-relationship-typefrom the FHIR Standard | |
| DocumentReference.securityLabel | example | SecurityLabelExampleshttp://hl7.org/fhir/ValueSet/security-label-examplesfrom the FHIR Standard | |
| DocumentReference.content.attachment.contentType | required | MimeTypes (a valid code from urn:ietf:bcp:13)http://hl7.org/fhir/ValueSet/mimetypes|5.0.0from the FHIR Standard | |
| DocumentReference.content.attachment.language | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages|5.0.0from the FHIR Standard |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() | C | 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 | ||||
![]() ![]() | S | 0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language
| ||||
![]() ![]() | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
![]() ![]() | 0..* | Resource | Contained, inline Resources | |||||
![]() ![]() | 0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() | SΣ | 1..* | Identifier | Business identifiers for the document | ||||
![]() ![]() | SΣ | 0..1 | string | An explicitly assigned identifer of a variation of the content in the DocumentReference | ||||
![]() ![]() | 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 | |||||
![]() ![]() | ?!Σ | 1..1 | code | current | superseded | entered-in-error Binding: DocumentReferenceStatus (required): The status of the document reference. | ||||
![]() ![]() | 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. | ||||
![]() ![]() | SΣ | 0..1 | CodeableConcept | Kind of document (LOINC if possible) Binding: FHIRDocumentTypeCodes (preferred): Precise type of clinical document. | ||||
![]() ![]() | Σ | 0..* | CodeableConcept | Categorization of document Binding: ReferencedItemCategoryValueSet (example): High-level kind of document at a macro level. | ||||
![]() ![]() | SΣ | 0..1 | Reference(Resource) | Who/what is the subject of the document | ||||
![]() ![]() | SC | 0..* | Reference(Appointment | Encounter | EpisodeOfCare) | Context of the document content | ||||
![]() ![]() | 0..* | CodeableReference() | Main clinical acts documented Binding: v3 Code System ActCode (example): This list of codes represents the main clinical acts being documented. | |||||
![]() ![]() | C | 0..1 | CodeableConcept | Kind of facility where patient was seen Binding: FacilityTypeCodeValueSet (example): XDS Facility Type. | ||||
![]() ![]() | 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). | ||||
![]() ![]() | Σ | 0..1 | Period | Time of service that is being documented | ||||
![]() ![]() | Σ | 0..1 | instant | When this document reference was created | ||||
![]() ![]() | SΣ | 0..* | Reference(Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson | CareTeam) | Who and/or what authored the document | ||||
![]() ![]() | S | 0..* | BackboneElement | Attests to accuracy of the 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 | ||||
![]() ![]() ![]() | 1..1 | CodeableConcept | personal | professional | legal | official Binding: CompositionAttestationMode (preferred): The way in which a person authenticated a document. | |||||
![]() ![]() ![]() | 0..1 | dateTime | When the document was attested | |||||
![]() ![]() ![]() | 0..1 | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole | Organization) | Who attested the document | |||||
![]() ![]() | S | 0..1 | Reference(Organization) | Organization which maintains the document | ||||
![]() ![]() | SΣ | 0..* | BackboneElement | Relationships to other documents | ||||
![]() ![]() ![]() | 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 | CodeableConcept | The relationship type with another document Binding: DocumentRelationshipType (extensible): The type of relationship between the documents. | ||||
![]() ![]() ![]() | Σ | 1..1 | Reference(DocumentReference) | Target of the relationship | ||||
![]() ![]() | SΣ | 0..1 | markdown | Human-readable description | ||||
![]() ![]() | SΣ | 0..* | CodeableConcept | Document security-tags Binding: SecurityLabelExamples (example): Example Security Labels from the Healthcare Privacy and Security Classification System. | ||||
![]() ![]() | SΣ | 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 | ||||
![]() ![]() ![]() | Σ | 1..1 | Attachment | Where to access the document | ||||
![]() ![]() ![]() ![]() | 0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() | SΣC | 0..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 | ||||
![]() ![]() ![]() ![]() | SΣ | 0..1 | code | Human language of the content (BCP-47) Binding: AllLanguages (required): IETF language tag for a human language.
Example General: en-AU | ||||
![]() ![]() ![]() ![]() | C | 0..1 | base64Binary | Data inline, base64ed | ||||
![]() ![]() ![]() ![]() | Σ | 0..1 | url | Uri where the data can be found Example General: http://www.acme.com/logo-small.png | ||||
![]() ![]() ![]() ![]() | Σ | 0..1 | integer64 | 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 | positiveInt | Height of the image in pixels (photo/video) | |||||
![]() ![]() ![]() ![]() | 0..1 | positiveInt | Width of the image in pixels (photo/video) | |||||
![]() ![]() ![]() ![]() | 0..1 | positiveInt | Number of frames if > 1 (photo) | |||||
![]() ![]() ![]() ![]() | 0..1 | decimal | Length in seconds (audio / video) | |||||
![]() ![]() ![]() ![]() | 0..1 | positiveInt | Number of printed pages | |||||
![]() ![]() ![]() | Σ | 0..* | BackboneElement | Content profile rules for the 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 | ||||
![]() ![]() ![]() ![]() | Σ | 1..1 | Code|uri|canonical Binding: HL7 ValueSet of Format Codes for use with Document Sharing (preferred): Document Format Codes. | |||||
![]() ![]() ![]() ![]() ![]() | Coding | |||||||
![]() ![]() ![]() ![]() ![]() | uri | |||||||
![]() ![]() ![]() ![]() ![]() | canonical(Any) | |||||||
Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI |
| DocumentReference.language | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages|5.0.0from the FHIR Standard | |
| DocumentReference.status | required | DocumentReferenceStatushttp://hl7.org/fhir/ValueSet/document-reference-status|5.0.0from the FHIR Standard | |
| DocumentReference.docStatus | required | CompositionStatushttp://hl7.org/fhir/ValueSet/composition-status|5.0.0from the FHIR Standard | |
| DocumentReference.type | preferred | FHIRDocumentTypeCodeshttp://hl7.org/fhir/ValueSet/doc-typecodesfrom the FHIR Standard | |
| DocumentReference.category | example | ReferencedItemCategoryValueSethttp://hl7.org/fhir/ValueSet/referenced-item-categoryfrom the FHIR Standard | |
| DocumentReference.event | example | ActCodehttp://terminology.hl7.org/ValueSet/v3-ActCode | |
| DocumentReference.facilityType | example | FacilityTypeCodeValueSethttp://hl7.org/fhir/ValueSet/c80-facilitycodesfrom the FHIR Standard | |
| DocumentReference.practiceSetting | example | PracticeSettingCodeValueSethttp://hl7.org/fhir/ValueSet/c80-practice-codesfrom the FHIR Standard | |
| DocumentReference.attester.mode | preferred | CompositionAttestationModehttp://hl7.org/fhir/ValueSet/composition-attestation-modefrom the FHIR Standard | |
| DocumentReference.relatesTo.code | extensible | DocumentRelationshipTypehttp://hl7.org/fhir/ValueSet/document-relationship-typefrom the FHIR Standard | |
| DocumentReference.securityLabel | example | SecurityLabelExampleshttp://hl7.org/fhir/ValueSet/security-label-examplesfrom the FHIR Standard | |
| DocumentReference.content.attachment.contentType | required | MimeTypes (a valid code from urn:ietf:bcp:13)http://hl7.org/fhir/ValueSet/mimetypes|5.0.0from the FHIR Standard | |
| DocumentReference.content.attachment.language | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages|5.0.0from the FHIR Standard | |
| DocumentReference.content.profile.value[x] | preferred | HL7FormatCodeshttp://terminology.hl7.org/ValueSet/v3-HL7FormatCodes |
This structure is derived from DocumentReference
Other representations of profile: CSV, Excel, Schematron