0.1.0 - ci-build
oncologyfhirigkenya - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
Official URL: http://example.org/StructureDefinition/oncology-kenya-registry-report | Version: 0.1.0 | |||
Draft as of 2025-06-24 | Computable Name: OncologyKenyaRegistryReport |
Defines structured cancer registry reporting format for Kenya, integrating with KEMRI Cancer Registry, Nairobi Cancer Registry, and DHIS2.
Usages:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from DocumentReference
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
0..* | DocumentReference | A reference to a document | |
![]() ![]() ![]() |
1..1 | code | current | superseded | entered-in-error Binding: DocumentReferenceStatus (required) | |
![]() ![]() ![]() |
0..1 | CodeableConcept | Kind of document (LOINC if possible) Binding: DocumentClassValueSet (required) | |
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Categorization of document |
![]() ![]() ![]() |
S | 1..1 | instant | When this document reference was created |
![]() ![]() ![]() |
S | 1..* | Reference(Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson) | Who and/or what authored the document |
![]() ![]() ![]() |
S | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | Who/what authenticated the document |
![]() ![]() ![]() |
S | 1..1 | Reference(Organization) | Organization which maintains the document |
![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | Mime type of the content, with charset etc. |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | base64Binary | Data inline, base64ed |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | url | Uri where the data can be found |
![]() ![]() ![]() ![]() |
S | 0..1 | Coding | Format/content rules for the document |
![]() |
Path | Conformance | ValueSet | URI |
DocumentReference.status | required | DocumentReferenceStatushttp://hl7.org/fhir/ValueSet/document-reference-status From the FHIR Standard | |
DocumentReference.type | required | DocumentClassValueSethttp://hl7.org/fhir/ValueSet/document-classcodes From the FHIR Standard |
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
0..* | DocumentReference | A reference to a document | |
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() |
?!Σ | 1..1 | code | current | superseded | entered-in-error Binding: DocumentReferenceStatus (required) |
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Kind of document (LOINC if possible) Binding: DocumentClassValueSet (required) |
![]() ![]() ![]() |
SΣ | 0..1 | CodeableConcept | Categorization of document Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level. |
![]() ![]() ![]() |
SΣ | 1..1 | instant | When this document reference was created |
![]() ![]() ![]() |
SΣ | 1..* | Reference(Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson) | Who and/or what authored the document |
![]() ![]() ![]() |
S | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | Who/what authenticated the document |
![]() ![]() ![]() |
S | 1..1 | Reference(Organization) | Organization which maintains the document |
![]() ![]() ![]() |
Σ | 1..* | BackboneElement | Document referenced |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
Σ | 1..1 | Attachment | Where to access the document |
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | Mime type of the content, with charset etc. Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. Example General: text/plain; charset=UTF-8, image/png |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | base64Binary | Data inline, base64ed |
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | url | Uri where the data can be found Example General: http://www.acme.com/logo-small.png |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | Coding | Format/content rules for the document Binding: DocumentReferenceFormatCodeSet (preferred): Document Format Codes. |
![]() |
Path | Conformance | ValueSet | URI |
DocumentReference.status | required | DocumentReferenceStatushttp://hl7.org/fhir/ValueSet/document-reference-status From the FHIR Standard | |
DocumentReference.type | required | DocumentClassValueSethttp://hl7.org/fhir/ValueSet/document-classcodes From the FHIR Standard | |
DocumentReference.category | example | DocumentClassValueSethttp://hl7.org/fhir/ValueSet/document-classcodes From the FHIR Standard | |
DocumentReference.content.attachment.contentType | required | Mime Types(a valid code from urn:ietf:bcp:13 )http://hl7.org/fhir/ValueSet/mimetypes|4.0.1 From the FHIR Standard | |
DocumentReference.content.format | preferred | DocumentReferenceFormatCodeSet(a valid code from http://ihe.net/fhir/ValueSet/IHE.FormatCode.codesystem )http://hl7.org/fhir/ValueSet/formatcodes From the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | DocumentReference | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | DocumentReference | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | DocumentReference | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | DocumentReference | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | DocumentReference | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
0..* | DocumentReference | A reference to a document | |||||
![]() ![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
Σ | 0..1 | Identifier | Master Version Specific Identifier | ||||
![]() ![]() ![]() |
Σ | 0..* | Identifier | Other identifiers for the document | ||||
![]() ![]() ![]() |
?!Σ | 1..1 | code | current | superseded | entered-in-error Binding: DocumentReferenceStatus (required) | ||||
![]() ![]() ![]() |
Σ | 0..1 | code | preliminary | final | amended | entered-in-error Binding: CompositionStatus (required): Status of the underlying document. | ||||
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Kind of document (LOINC if possible) Binding: DocumentClassValueSet (required) | ||||
![]() ![]() ![]() |
SΣ | 0..1 | CodeableConcept | Categorization of document Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level. | ||||
![]() ![]() ![]() |
Σ | 0..1 | Reference(Patient | Practitioner | Group | Device) | Who/what is the subject of the document | ||||
![]() ![]() ![]() |
SΣ | 1..1 | instant | When this document reference was created | ||||
![]() ![]() ![]() |
SΣ | 1..* | Reference(Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson) | Who and/or what authored the document | ||||
![]() ![]() ![]() |
S | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | Who/what authenticated the document | ||||
![]() ![]() ![]() |
S | 1..1 | Reference(Organization) | Organization which maintains the document | ||||
![]() ![]() ![]() |
Σ | 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 | code | replaces | transforms | signs | appends Binding: DocumentRelationshipType (required): The type of relationship between documents. | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | Reference(DocumentReference) | Target of the relationship | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Human-readable description | ||||
![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | Document security-tags Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
![]() ![]() ![]() |
Σ | 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 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | Mime type of the content, with charset etc. Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. Example General: text/plain; charset=UTF-8, image/png | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | code | Human language of the content (BCP-47) Binding: CommonLanguages (preferred): A human language.
Example General: en-AU | ||||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | base64Binary | Data inline, base64ed | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | url | Uri where the data can be found Example General: http://www.acme.com/logo-small.png | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | unsignedInt | Number of bytes of content (if url provided) | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | base64Binary | Hash of the data (sha-1, base64ed) | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Label to display in place of the data Example General: Official Corporate Logo | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | dateTime | Date attachment was first created | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | Coding | Format/content rules for the document Binding: DocumentReferenceFormatCodeSet (preferred): Document Format Codes. | ||||
![]() ![]() ![]() |
Σ | 0..1 | BackboneElement | Clinical context of document | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
0..* | Reference(Encounter | EpisodeOfCare) | Context of the document content | |||||
![]() ![]() ![]() ![]() |
0..* | CodeableConcept | Main clinical acts documented Binding: v3 Code System ActCode (example): This list of codes represents the main clinical acts being documented. | |||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time of service that is being documented | ||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Kind of facility where patient was seen Binding: FacilityTypeCodeValueSet (example): XDS Facility Type. | |||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Additional details about where the content was created (e.g. clinical specialty) Binding: PracticeSettingCodeValueSet (example): Additional details about where the content was created (e.g. clinical specialty). | |||||
![]() ![]() ![]() ![]() |
0..1 | Reference(Patient) | Patient demographics from source | |||||
![]() ![]() ![]() ![]() |
0..* | Reference(Resource) | Related identifiers or resources | |||||
![]() |
Path | Conformance | ValueSet | URI | |||
DocumentReference.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages From the FHIR Standard
| ||||
DocumentReference.status | required | DocumentReferenceStatushttp://hl7.org/fhir/ValueSet/document-reference-status From the FHIR Standard | ||||
DocumentReference.docStatus | required | CompositionStatushttp://hl7.org/fhir/ValueSet/composition-status|4.0.1 From the FHIR Standard | ||||
DocumentReference.type | required | DocumentClassValueSethttp://hl7.org/fhir/ValueSet/document-classcodes From the FHIR Standard | ||||
DocumentReference.category | example | DocumentClassValueSethttp://hl7.org/fhir/ValueSet/document-classcodes From the FHIR Standard | ||||
DocumentReference.relatesTo.code | required | DocumentRelationshipTypehttp://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1 From the FHIR Standard | ||||
DocumentReference.securityLabel | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels From the FHIR Standard | ||||
DocumentReference.content.attachment.contentType | required | Mime Types(a valid code from urn:ietf:bcp:13 )http://hl7.org/fhir/ValueSet/mimetypes|4.0.1 From the FHIR Standard | ||||
DocumentReference.content.attachment.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages From the FHIR Standard
| ||||
DocumentReference.content.format | preferred | DocumentReferenceFormatCodeSet(a valid code from http://ihe.net/fhir/ValueSet/IHE.FormatCode.codesystem )http://hl7.org/fhir/ValueSet/formatcodes From the FHIR Standard | ||||
DocumentReference.context.event | example | ActCodehttp://terminology.hl7.org/ValueSet/v3-ActCode | ||||
DocumentReference.context.facilityType | example | FacilityTypeCodeValueSethttp://hl7.org/fhir/ValueSet/c80-facilitycodes From the FHIR Standard | ||||
DocumentReference.context.practiceSetting | example | PracticeSettingCodeValueSethttp://hl7.org/fhir/ValueSet/c80-practice-codes From the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | DocumentReference | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | DocumentReference | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | DocumentReference | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | DocumentReference | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | DocumentReference | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from DocumentReference
Differential View
This structure is derived from DocumentReference
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
0..* | DocumentReference | A reference to a document | |
![]() ![]() ![]() |
1..1 | code | current | superseded | entered-in-error Binding: DocumentReferenceStatus (required) | |
![]() ![]() ![]() |
0..1 | CodeableConcept | Kind of document (LOINC if possible) Binding: DocumentClassValueSet (required) | |
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Categorization of document |
![]() ![]() ![]() |
S | 1..1 | instant | When this document reference was created |
![]() ![]() ![]() |
S | 1..* | Reference(Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson) | Who and/or what authored the document |
![]() ![]() ![]() |
S | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | Who/what authenticated the document |
![]() ![]() ![]() |
S | 1..1 | Reference(Organization) | Organization which maintains the document |
![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | Mime type of the content, with charset etc. |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | base64Binary | Data inline, base64ed |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | url | Uri where the data can be found |
![]() ![]() ![]() ![]() |
S | 0..1 | Coding | Format/content rules for the document |
![]() |
Path | Conformance | ValueSet | URI |
DocumentReference.status | required | DocumentReferenceStatushttp://hl7.org/fhir/ValueSet/document-reference-status From the FHIR Standard | |
DocumentReference.type | required | DocumentClassValueSethttp://hl7.org/fhir/ValueSet/document-classcodes From the FHIR Standard |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
0..* | DocumentReference | A reference to a document | |
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() |
?!Σ | 1..1 | code | current | superseded | entered-in-error Binding: DocumentReferenceStatus (required) |
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Kind of document (LOINC if possible) Binding: DocumentClassValueSet (required) |
![]() ![]() ![]() |
SΣ | 0..1 | CodeableConcept | Categorization of document Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level. |
![]() ![]() ![]() |
SΣ | 1..1 | instant | When this document reference was created |
![]() ![]() ![]() |
SΣ | 1..* | Reference(Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson) | Who and/or what authored the document |
![]() ![]() ![]() |
S | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | Who/what authenticated the document |
![]() ![]() ![]() |
S | 1..1 | Reference(Organization) | Organization which maintains the document |
![]() ![]() ![]() |
Σ | 1..* | BackboneElement | Document referenced |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
Σ | 1..1 | Attachment | Where to access the document |
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | Mime type of the content, with charset etc. Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. Example General: text/plain; charset=UTF-8, image/png |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | base64Binary | Data inline, base64ed |
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | url | Uri where the data can be found Example General: http://www.acme.com/logo-small.png |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | Coding | Format/content rules for the document Binding: DocumentReferenceFormatCodeSet (preferred): Document Format Codes. |
![]() |
Path | Conformance | ValueSet | URI |
DocumentReference.status | required | DocumentReferenceStatushttp://hl7.org/fhir/ValueSet/document-reference-status From the FHIR Standard | |
DocumentReference.type | required | DocumentClassValueSethttp://hl7.org/fhir/ValueSet/document-classcodes From the FHIR Standard | |
DocumentReference.category | example | DocumentClassValueSethttp://hl7.org/fhir/ValueSet/document-classcodes From the FHIR Standard | |
DocumentReference.content.attachment.contentType | required | Mime Types(a valid code from urn:ietf:bcp:13 )http://hl7.org/fhir/ValueSet/mimetypes|4.0.1 From the FHIR Standard | |
DocumentReference.content.format | preferred | DocumentReferenceFormatCodeSet(a valid code from http://ihe.net/fhir/ValueSet/IHE.FormatCode.codesystem )http://hl7.org/fhir/ValueSet/formatcodes From the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | DocumentReference | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | DocumentReference | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | DocumentReference | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | DocumentReference | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | DocumentReference | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
0..* | DocumentReference | A reference to a document | |||||
![]() ![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
Σ | 0..1 | Identifier | Master Version Specific Identifier | ||||
![]() ![]() ![]() |
Σ | 0..* | Identifier | Other identifiers for the document | ||||
![]() ![]() ![]() |
?!Σ | 1..1 | code | current | superseded | entered-in-error Binding: DocumentReferenceStatus (required) | ||||
![]() ![]() ![]() |
Σ | 0..1 | code | preliminary | final | amended | entered-in-error Binding: CompositionStatus (required): Status of the underlying document. | ||||
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Kind of document (LOINC if possible) Binding: DocumentClassValueSet (required) | ||||
![]() ![]() ![]() |
SΣ | 0..1 | CodeableConcept | Categorization of document Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level. | ||||
![]() ![]() ![]() |
Σ | 0..1 | Reference(Patient | Practitioner | Group | Device) | Who/what is the subject of the document | ||||
![]() ![]() ![]() |
SΣ | 1..1 | instant | When this document reference was created | ||||
![]() ![]() ![]() |
SΣ | 1..* | Reference(Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson) | Who and/or what authored the document | ||||
![]() ![]() ![]() |
S | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | Who/what authenticated the document | ||||
![]() ![]() ![]() |
S | 1..1 | Reference(Organization) | Organization which maintains the document | ||||
![]() ![]() ![]() |
Σ | 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 | code | replaces | transforms | signs | appends Binding: DocumentRelationshipType (required): The type of relationship between documents. | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | Reference(DocumentReference) | Target of the relationship | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Human-readable description | ||||
![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | Document security-tags Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
![]() ![]() ![]() |
Σ | 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 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | Mime type of the content, with charset etc. Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. Example General: text/plain; charset=UTF-8, image/png | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | code | Human language of the content (BCP-47) Binding: CommonLanguages (preferred): A human language.
Example General: en-AU | ||||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | base64Binary | Data inline, base64ed | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | url | Uri where the data can be found Example General: http://www.acme.com/logo-small.png | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | unsignedInt | Number of bytes of content (if url provided) | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | base64Binary | Hash of the data (sha-1, base64ed) | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Label to display in place of the data Example General: Official Corporate Logo | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | dateTime | Date attachment was first created | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | Coding | Format/content rules for the document Binding: DocumentReferenceFormatCodeSet (preferred): Document Format Codes. | ||||
![]() ![]() ![]() |
Σ | 0..1 | BackboneElement | Clinical context of document | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
0..* | Reference(Encounter | EpisodeOfCare) | Context of the document content | |||||
![]() ![]() ![]() ![]() |
0..* | CodeableConcept | Main clinical acts documented Binding: v3 Code System ActCode (example): This list of codes represents the main clinical acts being documented. | |||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time of service that is being documented | ||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Kind of facility where patient was seen Binding: FacilityTypeCodeValueSet (example): XDS Facility Type. | |||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Additional details about where the content was created (e.g. clinical specialty) Binding: PracticeSettingCodeValueSet (example): Additional details about where the content was created (e.g. clinical specialty). | |||||
![]() ![]() ![]() ![]() |
0..1 | Reference(Patient) | Patient demographics from source | |||||
![]() ![]() ![]() ![]() |
0..* | Reference(Resource) | Related identifiers or resources | |||||
![]() |
Path | Conformance | ValueSet | URI | |||
DocumentReference.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages From the FHIR Standard
| ||||
DocumentReference.status | required | DocumentReferenceStatushttp://hl7.org/fhir/ValueSet/document-reference-status From the FHIR Standard | ||||
DocumentReference.docStatus | required | CompositionStatushttp://hl7.org/fhir/ValueSet/composition-status|4.0.1 From the FHIR Standard | ||||
DocumentReference.type | required | DocumentClassValueSethttp://hl7.org/fhir/ValueSet/document-classcodes From the FHIR Standard | ||||
DocumentReference.category | example | DocumentClassValueSethttp://hl7.org/fhir/ValueSet/document-classcodes From the FHIR Standard | ||||
DocumentReference.relatesTo.code | required | DocumentRelationshipTypehttp://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1 From the FHIR Standard | ||||
DocumentReference.securityLabel | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels From the FHIR Standard | ||||
DocumentReference.content.attachment.contentType | required | Mime Types(a valid code from urn:ietf:bcp:13 )http://hl7.org/fhir/ValueSet/mimetypes|4.0.1 From the FHIR Standard | ||||
DocumentReference.content.attachment.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages From the FHIR Standard
| ||||
DocumentReference.content.format | preferred | DocumentReferenceFormatCodeSet(a valid code from http://ihe.net/fhir/ValueSet/IHE.FormatCode.codesystem )http://hl7.org/fhir/ValueSet/formatcodes From the FHIR Standard | ||||
DocumentReference.context.event | example | ActCodehttp://terminology.hl7.org/ValueSet/v3-ActCode | ||||
DocumentReference.context.facilityType | example | FacilityTypeCodeValueSethttp://hl7.org/fhir/ValueSet/c80-facilitycodes From the FHIR Standard | ||||
DocumentReference.context.practiceSetting | example | PracticeSettingCodeValueSethttp://hl7.org/fhir/ValueSet/c80-practice-codes From the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | DocumentReference | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | DocumentReference | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | DocumentReference | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | DocumentReference | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | DocumentReference | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from DocumentReference
Other representations of profile: CSV, Excel, Schematron