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/AdditionalSupportMaterial | Version: 0.1.0 | |||
Active as of 2024-12-20 | Computable Name: AdditionalSupportMaterial |
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 |
---|---|---|---|---|
DocumentReference | 0..* | DocumentReference | A reference to a document | |
language | S | 0..1 | code | Language of the resource content |
Slices for extension | S | 0..* | Extension | Extension Slice: Unordered, Open by value:url |
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 |
version | S | 0..1 | string | An explicitly assigned identifer of a variation of the content in the DocumentReference |
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 | 0..* | 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 | 0..* | 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 |
attachment | ||||
contentType | S | 0..1 | code | Mime type of the content, with charset etc. |
language | S | 0..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) | |
Documentation for this format |
Path | Conformance | ValueSet | URI |
DocumentReference.category | preferred | ASMCategoryVS (a valid code from Category of ASM)http://hl7.eu/fhir/ig/gravitate-health/ValueSet/asm-category-vs from this IG | |
DocumentReference.content.profile.value[x] | preferred | TypeOfDataVS (a valid code from Type of information to be added in epi CS)http://hl7.eu/fhir/ig/gravitate-health/ValueSet/type-of-data-vs from this IG |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
DocumentReference | C | 0..* | DocumentReference | A 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 dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children | ||||
language | S | 0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language
ele-1: All FHIR elements must have a @value or children | ||||
contained | 0..* | Resource | Contained, inline Resources | |||||
Slices for extension | S | 0..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | ||||
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 ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | ||||
identifier | SΣ | 1..* | Identifier | Business identifiers for the document ele-1: All FHIR elements must have a @value or children | ||||
version | SΣ | 0..1 | string | An explicitly assigned identifer of a variation of the content in the DocumentReference ele-1: All FHIR elements must have a @value or children | ||||
status | ?!Σ | 1..1 | code | current | superseded | entered-in-error Binding: DocumentReferenceStatus (required): The status of the document reference. ele-1: All FHIR elements must have a @value or children | ||||
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. ele-1: All FHIR elements must have a @value or children | ||||
type | SΣ | 0..1 | CodeableConcept | Kind of document (LOINC if possible) Binding: FHIRDocumentTypeCodes (preferred): Precise type of clinical document. ele-1: All FHIR elements must have a @value or children | ||||
category | SΣ | 0..* | CodeableConcept | Categorization of document Binding: ASMCategoryVS (preferred) ele-1: All FHIR elements must have a @value or children | ||||
subject | SΣ | 0..1 | Reference(Resource) | Who/what is the subject of the document ele-1: All FHIR elements must have a @value or children | ||||
context | SC | 0..* | Reference(Appointment | Encounter | EpisodeOfCare) | Context of the document content ele-1: All FHIR elements must have a @value or children | ||||
author | SΣ | 0..* | Reference(Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson | CareTeam) | Who and/or what authored the document ele-1: All FHIR elements must have a @value or children | ||||
attester | S | 0..* | BackboneElement | Attests to accuracy of the document ele-1: All FHIR elements must have a @value or children | ||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | ||||
mode | 1..1 | CodeableConcept | personal | professional | legal | official Binding: CompositionAttestationMode (preferred): The way in which a person authenticated a document. ele-1: All FHIR elements must have a @value or children | |||||
custodian | S | 0..1 | Reference(Organization) | Organization which maintains the document ele-1: All FHIR elements must have a @value or children | ||||
relatesTo | SΣ | 0..* | BackboneElement | Relationships to other documents ele-1: All FHIR elements must have a @value or children | ||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | ||||
code | Σ | 1..1 | CodeableConcept | The relationship type with another document Binding: DocumentRelationshipType (extensible): The type of relationship between the documents. ele-1: All FHIR elements must have a @value or children | ||||
target | Σ | 1..1 | Reference(DocumentReference) | Target of the relationship ele-1: All FHIR elements must have a @value or children | ||||
description | SΣ | 0..1 | markdown | Human-readable description ele-1: All FHIR elements must have a @value or children | ||||
securityLabel | SΣ | 0..* | CodeableConcept | Document security-tags Binding: SecurityLabelExamples (example): Example Security Labels from the Healthcare Privacy and Security Classification System. ele-1: All FHIR elements must have a @value or children | ||||
content | SΣ | 1..1 | BackboneElement | Document referenced ele-1: All FHIR elements must have a @value or children | ||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | ||||
attachment | Σ | 1..1 | Attachment | Where to access the document ele-1: All FHIR elements must have a @value or children | ||||
contentType | 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) ele-1: All FHIR elements must have a @value or children Example General: text/plain; charset=UTF-8, image/png | ||||
language | SΣ | 0..1 | code | Human language of the content (BCP-47) Binding: AllLanguages (required): IETF language tag for a human language.
ele-1: All FHIR elements must have a @value or children Example General: en-AU | ||||
data | SC | 0..1 | base64Binary | Data inline, base64ed ele-1: All FHIR elements must have a @value or children | ||||
url | SΣ | 0..1 | url | Uri where the data can be found ele-1: All FHIR elements must have a @value or children Example General: http://www.acme.com/logo-small.png | ||||
hash | SΣ | 0..1 | base64Binary | Hash of the data (sha-1, base64ed) ele-1: All FHIR elements must have a @value or children | ||||
title | SΣ | 1..1 | string | Label to display in place of the data ele-1: All FHIR elements must have a @value or children Example General: Official Corporate Logo | ||||
creation | SΣ | 0..1 | dateTime | Date attachment was first created ele-1: All FHIR elements must have a @value or children | ||||
Documentation for this format |
Path | Conformance | ValueSet | URI |
DocumentReference.language | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages|5.0.0 from the FHIR Standard | |
DocumentReference.status | required | DocumentReferenceStatushttp://hl7.org/fhir/ValueSet/document-reference-status|5.0.0 from the FHIR Standard | |
DocumentReference.docStatus | required | CompositionStatushttp://hl7.org/fhir/ValueSet/composition-status|5.0.0 from the FHIR Standard | |
DocumentReference.type | preferred | FHIRDocumentTypeCodeshttp://hl7.org/fhir/ValueSet/doc-typecodes from the FHIR Standard | |
DocumentReference.category | preferred | ASMCategoryVS (a valid code from Category of ASM)http://hl7.eu/fhir/ig/gravitate-health/ValueSet/asm-category-vs from this IG | |
DocumentReference.attester.mode | preferred | CompositionAttestationModehttp://hl7.org/fhir/ValueSet/composition-attestation-mode from the FHIR Standard | |
DocumentReference.relatesTo.code | extensible | DocumentRelationshipTypehttp://hl7.org/fhir/ValueSet/document-relationship-type from the FHIR Standard | |
DocumentReference.securityLabel | example | SecurityLabelExampleshttp://hl7.org/fhir/ValueSet/security-label-examples from 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.0 from the FHIR Standard | |
DocumentReference.content.attachment.language | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages|5.0.0 from the FHIR Standard |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
DocumentReference | C | 0..* | DocumentReference | A 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..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
| ||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
Slices for extension | S | 0..* | Extension | Extension Slice: Unordered, Open by value:url | ||||
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Σ | 0..* | 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Σ | 0..* | 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 | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
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 | 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 | ||||
language | 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 | ||||
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) | ||||
Documentation for this format |
Path | Conformance | ValueSet | URI |
DocumentReference.language | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages|5.0.0 from the FHIR Standard | |
DocumentReference.status | required | DocumentReferenceStatushttp://hl7.org/fhir/ValueSet/document-reference-status|5.0.0 from the FHIR Standard | |
DocumentReference.docStatus | required | CompositionStatushttp://hl7.org/fhir/ValueSet/composition-status|5.0.0 from the FHIR Standard | |
DocumentReference.type | preferred | FHIRDocumentTypeCodeshttp://hl7.org/fhir/ValueSet/doc-typecodes from the FHIR Standard | |
DocumentReference.category | preferred | ASMCategoryVS (a valid code from Category of ASM)http://hl7.eu/fhir/ig/gravitate-health/ValueSet/asm-category-vs from this IG | |
DocumentReference.event | example | ActCodehttp://terminology.hl7.org/ValueSet/v3-ActCode | |
DocumentReference.facilityType | example | FacilityTypeCodeValueSethttp://hl7.org/fhir/ValueSet/c80-facilitycodes from the FHIR Standard | |
DocumentReference.practiceSetting | example | PracticeSettingCodeValueSethttp://hl7.org/fhir/ValueSet/c80-practice-codes from the FHIR Standard | |
DocumentReference.attester.mode | preferred | CompositionAttestationModehttp://hl7.org/fhir/ValueSet/composition-attestation-mode from the FHIR Standard | |
DocumentReference.relatesTo.code | extensible | DocumentRelationshipTypehttp://hl7.org/fhir/ValueSet/document-relationship-type from the FHIR Standard | |
DocumentReference.securityLabel | example | SecurityLabelExampleshttp://hl7.org/fhir/ValueSet/security-label-examples from 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.0 from the FHIR Standard | |
DocumentReference.content.attachment.language | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages|5.0.0 from the FHIR Standard | |
DocumentReference.content.profile.value[x] | preferred | TypeOfDataVS (a valid code from Type of information to be added in epi CS)http://hl7.eu/fhir/ig/gravitate-health/ValueSet/type-of-data-vs from this IG |
This structure is derived from DocumentReference
Differential View
This structure is derived from DocumentReference
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
DocumentReference | 0..* | DocumentReference | A reference to a document | |
language | S | 0..1 | code | Language of the resource content |
Slices for extension | S | 0..* | Extension | Extension Slice: Unordered, Open by value:url |
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 |
version | S | 0..1 | string | An explicitly assigned identifer of a variation of the content in the DocumentReference |
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 | 0..* | 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 | 0..* | 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 |
attachment | ||||
contentType | S | 0..1 | code | Mime type of the content, with charset etc. |
language | S | 0..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) | |
Documentation for this format |
Path | Conformance | ValueSet | URI |
DocumentReference.category | preferred | ASMCategoryVS (a valid code from Category of ASM)http://hl7.eu/fhir/ig/gravitate-health/ValueSet/asm-category-vs from this IG | |
DocumentReference.content.profile.value[x] | preferred | TypeOfDataVS (a valid code from Type of information to be added in epi CS)http://hl7.eu/fhir/ig/gravitate-health/ValueSet/type-of-data-vs from this IG |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
DocumentReference | C | 0..* | DocumentReference | A 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 dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children | ||||
language | S | 0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language
ele-1: All FHIR elements must have a @value or children | ||||
contained | 0..* | Resource | Contained, inline Resources | |||||
Slices for extension | S | 0..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | ||||
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 ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | ||||
identifier | SΣ | 1..* | Identifier | Business identifiers for the document ele-1: All FHIR elements must have a @value or children | ||||
version | SΣ | 0..1 | string | An explicitly assigned identifer of a variation of the content in the DocumentReference ele-1: All FHIR elements must have a @value or children | ||||
status | ?!Σ | 1..1 | code | current | superseded | entered-in-error Binding: DocumentReferenceStatus (required): The status of the document reference. ele-1: All FHIR elements must have a @value or children | ||||
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. ele-1: All FHIR elements must have a @value or children | ||||
type | SΣ | 0..1 | CodeableConcept | Kind of document (LOINC if possible) Binding: FHIRDocumentTypeCodes (preferred): Precise type of clinical document. ele-1: All FHIR elements must have a @value or children | ||||
category | SΣ | 0..* | CodeableConcept | Categorization of document Binding: ASMCategoryVS (preferred) ele-1: All FHIR elements must have a @value or children | ||||
subject | SΣ | 0..1 | Reference(Resource) | Who/what is the subject of the document ele-1: All FHIR elements must have a @value or children | ||||
context | SC | 0..* | Reference(Appointment | Encounter | EpisodeOfCare) | Context of the document content ele-1: All FHIR elements must have a @value or children | ||||
author | SΣ | 0..* | Reference(Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson | CareTeam) | Who and/or what authored the document ele-1: All FHIR elements must have a @value or children | ||||
attester | S | 0..* | BackboneElement | Attests to accuracy of the document ele-1: All FHIR elements must have a @value or children | ||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | ||||
mode | 1..1 | CodeableConcept | personal | professional | legal | official Binding: CompositionAttestationMode (preferred): The way in which a person authenticated a document. ele-1: All FHIR elements must have a @value or children | |||||
custodian | S | 0..1 | Reference(Organization) | Organization which maintains the document ele-1: All FHIR elements must have a @value or children | ||||
relatesTo | SΣ | 0..* | BackboneElement | Relationships to other documents ele-1: All FHIR elements must have a @value or children | ||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | ||||
code | Σ | 1..1 | CodeableConcept | The relationship type with another document Binding: DocumentRelationshipType (extensible): The type of relationship between the documents. ele-1: All FHIR elements must have a @value or children | ||||
target | Σ | 1..1 | Reference(DocumentReference) | Target of the relationship ele-1: All FHIR elements must have a @value or children | ||||
description | SΣ | 0..1 | markdown | Human-readable description ele-1: All FHIR elements must have a @value or children | ||||
securityLabel | SΣ | 0..* | CodeableConcept | Document security-tags Binding: SecurityLabelExamples (example): Example Security Labels from the Healthcare Privacy and Security Classification System. ele-1: All FHIR elements must have a @value or children | ||||
content | SΣ | 1..1 | BackboneElement | Document referenced ele-1: All FHIR elements must have a @value or children | ||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | ||||
attachment | Σ | 1..1 | Attachment | Where to access the document ele-1: All FHIR elements must have a @value or children | ||||
contentType | 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) ele-1: All FHIR elements must have a @value or children Example General: text/plain; charset=UTF-8, image/png | ||||
language | SΣ | 0..1 | code | Human language of the content (BCP-47) Binding: AllLanguages (required): IETF language tag for a human language.
ele-1: All FHIR elements must have a @value or children Example General: en-AU | ||||
data | SC | 0..1 | base64Binary | Data inline, base64ed ele-1: All FHIR elements must have a @value or children | ||||
url | SΣ | 0..1 | url | Uri where the data can be found ele-1: All FHIR elements must have a @value or children Example General: http://www.acme.com/logo-small.png | ||||
hash | SΣ | 0..1 | base64Binary | Hash of the data (sha-1, base64ed) ele-1: All FHIR elements must have a @value or children | ||||
title | SΣ | 1..1 | string | Label to display in place of the data ele-1: All FHIR elements must have a @value or children Example General: Official Corporate Logo | ||||
creation | SΣ | 0..1 | dateTime | Date attachment was first created ele-1: All FHIR elements must have a @value or children | ||||
Documentation for this format |
Path | Conformance | ValueSet | URI |
DocumentReference.language | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages|5.0.0 from the FHIR Standard | |
DocumentReference.status | required | DocumentReferenceStatushttp://hl7.org/fhir/ValueSet/document-reference-status|5.0.0 from the FHIR Standard | |
DocumentReference.docStatus | required | CompositionStatushttp://hl7.org/fhir/ValueSet/composition-status|5.0.0 from the FHIR Standard | |
DocumentReference.type | preferred | FHIRDocumentTypeCodeshttp://hl7.org/fhir/ValueSet/doc-typecodes from the FHIR Standard | |
DocumentReference.category | preferred | ASMCategoryVS (a valid code from Category of ASM)http://hl7.eu/fhir/ig/gravitate-health/ValueSet/asm-category-vs from this IG | |
DocumentReference.attester.mode | preferred | CompositionAttestationModehttp://hl7.org/fhir/ValueSet/composition-attestation-mode from the FHIR Standard | |
DocumentReference.relatesTo.code | extensible | DocumentRelationshipTypehttp://hl7.org/fhir/ValueSet/document-relationship-type from the FHIR Standard | |
DocumentReference.securityLabel | example | SecurityLabelExampleshttp://hl7.org/fhir/ValueSet/security-label-examples from 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.0 from the FHIR Standard | |
DocumentReference.content.attachment.language | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages|5.0.0 from the FHIR Standard |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
DocumentReference | C | 0..* | DocumentReference | A 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..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
| ||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
Slices for extension | S | 0..* | Extension | Extension Slice: Unordered, Open by value:url | ||||
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Σ | 0..* | 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Σ | 0..* | 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 | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
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 | 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 | ||||
language | 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 | ||||
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) | ||||
Documentation for this format |
Path | Conformance | ValueSet | URI |
DocumentReference.language | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages|5.0.0 from the FHIR Standard | |
DocumentReference.status | required | DocumentReferenceStatushttp://hl7.org/fhir/ValueSet/document-reference-status|5.0.0 from the FHIR Standard | |
DocumentReference.docStatus | required | CompositionStatushttp://hl7.org/fhir/ValueSet/composition-status|5.0.0 from the FHIR Standard | |
DocumentReference.type | preferred | FHIRDocumentTypeCodeshttp://hl7.org/fhir/ValueSet/doc-typecodes from the FHIR Standard | |
DocumentReference.category | preferred | ASMCategoryVS (a valid code from Category of ASM)http://hl7.eu/fhir/ig/gravitate-health/ValueSet/asm-category-vs from this IG | |
DocumentReference.event | example | ActCodehttp://terminology.hl7.org/ValueSet/v3-ActCode | |
DocumentReference.facilityType | example | FacilityTypeCodeValueSethttp://hl7.org/fhir/ValueSet/c80-facilitycodes from the FHIR Standard | |
DocumentReference.practiceSetting | example | PracticeSettingCodeValueSethttp://hl7.org/fhir/ValueSet/c80-practice-codes from the FHIR Standard | |
DocumentReference.attester.mode | preferred | CompositionAttestationModehttp://hl7.org/fhir/ValueSet/composition-attestation-mode from the FHIR Standard | |
DocumentReference.relatesTo.code | extensible | DocumentRelationshipTypehttp://hl7.org/fhir/ValueSet/document-relationship-type from the FHIR Standard | |
DocumentReference.securityLabel | example | SecurityLabelExampleshttp://hl7.org/fhir/ValueSet/security-label-examples from 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.0 from the FHIR Standard | |
DocumentReference.content.attachment.language | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages|5.0.0 from the FHIR Standard | |
DocumentReference.content.profile.value[x] | preferred | TypeOfDataVS (a valid code from Type of information to be added in epi CS)http://hl7.eu/fhir/ig/gravitate-health/ValueSet/type-of-data-vs from this IG |
This structure is derived from DocumentReference
Other representations of profile: CSV, Excel, Schematron