HL7 FHIR Malaysia Core (MY Core) Implementation Guide
2.0.0 - ci-build
HL7 FHIR Malaysia Core (MY Core) Implementation Guide - Local Development build (v2.0.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
Official URL: http://fhir.hie.moh.gov.my/StructureDefinition/DocumentManifest-my-core | Version: 2.0.0 | |||
Active as of 2024-02-12 | Computable Name: DocumentManifestMyCore |
A collection of documents compiled for a purpose together with metadata that applies to the collection. In the Malaysian context, this resource is used to manage collections such as maternal health records (Ministry of Health pink book), child health records (Ministry of Health blue book), and pre-hajj medical screening records.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
0..* | DocumentManifest | A list that defines a set of documents 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 | |
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
?! | 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 |
![]() ![]() ![]() |
?!Σ | 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 |
![]() ![]() ![]() |
Σ | 1..1 | CodeableConcept | Kind of document set Binding: ValueSetSubRecordType (MY Core) (required) ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
Σ | 1..* | Reference(Resource) | Items in manifest ele-1: All FHIR elements must have a @value or children |
![]() |
Path | Conformance | ValueSet | URI |
DocumentManifest.status | required | DocumentReferenceStatushttp://hl7.org/fhir/ValueSet/document-reference-status|4.0.1 from the FHIR Standard | |
DocumentManifest.type | required | ValueSetSubRecordTypeMyCore (a valid code from CodeSystemSubRecordType (MY Core))http://fhir.hie.moh.gov.my/ValueSet/sub-record-type-my-core from this IG |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | DocumentManifest | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | DocumentManifest | 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 | DocumentManifest | 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 | DocumentManifest | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | DocumentManifest | 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 DocumentManifest
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
0..* | DocumentManifest | A list that defines a set of documents | |
![]() ![]() ![]() |
1..1 | CodeableConcept | Kind of document set Binding: ValueSetSubRecordType (MY Core) (required) | |
![]() |
Path | Conformance | ValueSet | URI |
DocumentManifest.type | required | ValueSetSubRecordTypeMyCore (a valid code from CodeSystemSubRecordType (MY Core))http://fhir.hie.moh.gov.my/ValueSet/sub-record-type-my-core from this IG |
Name | Flags | Card. | Type | Description & Constraints![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
0..* | DocumentManifest | A list that defines a set of documents | |||||
![]() ![]() ![]() |
Σ | 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 | |||||
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
Σ | 0..1 | Identifier | Unique Identifier for the set of documents | ||||
![]() ![]() ![]() |
Σ | 0..* | Identifier | Other identifiers for the manifest | ||||
![]() ![]() ![]() |
?!Σ | 1..1 | code | current | superseded | entered-in-error Binding: DocumentReferenceStatus (required): The status of the document reference. | ||||
![]() ![]() ![]() |
Σ | 1..1 | CodeableConcept | Kind of document set Binding: ValueSetSubRecordType (MY Core) (required) | ||||
![]() ![]() ![]() |
Σ | 0..1 | Reference(Patient | Practitioner | Group | Device) | The subject of the set of documents | ||||
![]() ![]() ![]() |
0..1 | dateTime | When this document manifest created | |||||
![]() ![]() ![]() |
Σ | 0..* | Reference(Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson) | Who and/or what authored the DocumentManifest | ||||
![]() ![]() ![]() |
0..* | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Organization) | Intended to get notified about this set of documents | |||||
![]() ![]() ![]() |
0..1 | uri | The source system/application/software | |||||
![]() ![]() ![]() |
Σ | 0..1 | string | Human-readable description (title) | ||||
![]() ![]() ![]() |
Σ | 1..* | Reference(Resource) | Items in manifest | ||||
![]() ![]() ![]() |
0..* | BackboneElement | Related things | |||||
![]() ![]() ![]() ![]() |
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..1 | Identifier | Identifiers of things that are related | |||||
![]() ![]() ![]() ![]() |
0..1 | Reference(Resource) | Related Resource | |||||
![]() |
Path | Conformance | ValueSet | URI | |||
DocumentManifest.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages from the FHIR Standard
| ||||
DocumentManifest.status | required | DocumentReferenceStatushttp://hl7.org/fhir/ValueSet/document-reference-status|4.0.1 from the FHIR Standard | ||||
DocumentManifest.type | required | ValueSetSubRecordTypeMyCore (a valid code from CodeSystemSubRecordType (MY Core))http://fhir.hie.moh.gov.my/ValueSet/sub-record-type-my-core from this IG |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | DocumentManifest | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | DocumentManifest | 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 | DocumentManifest | 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 | DocumentManifest | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | DocumentManifest | 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 DocumentManifest
Key Elements View
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
0..* | DocumentManifest | A list that defines a set of documents 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 | |
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
?! | 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 |
![]() ![]() ![]() |
?!Σ | 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 |
![]() ![]() ![]() |
Σ | 1..1 | CodeableConcept | Kind of document set Binding: ValueSetSubRecordType (MY Core) (required) ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
Σ | 1..* | Reference(Resource) | Items in manifest ele-1: All FHIR elements must have a @value or children |
![]() |
Path | Conformance | ValueSet | URI |
DocumentManifest.status | required | DocumentReferenceStatushttp://hl7.org/fhir/ValueSet/document-reference-status|4.0.1 from the FHIR Standard | |
DocumentManifest.type | required | ValueSetSubRecordTypeMyCore (a valid code from CodeSystemSubRecordType (MY Core))http://fhir.hie.moh.gov.my/ValueSet/sub-record-type-my-core from this IG |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | DocumentManifest | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | DocumentManifest | 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 | DocumentManifest | 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 | DocumentManifest | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | DocumentManifest | 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() |
Differential View
This structure is derived from DocumentManifest
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
0..* | DocumentManifest | A list that defines a set of documents | |
![]() ![]() ![]() |
1..1 | CodeableConcept | Kind of document set Binding: ValueSetSubRecordType (MY Core) (required) | |
![]() |
Path | Conformance | ValueSet | URI |
DocumentManifest.type | required | ValueSetSubRecordTypeMyCore (a valid code from CodeSystemSubRecordType (MY Core))http://fhir.hie.moh.gov.my/ValueSet/sub-record-type-my-core from this IG |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
0..* | DocumentManifest | A list that defines a set of documents | |||||
![]() ![]() ![]() |
Σ | 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 | |||||
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
Σ | 0..1 | Identifier | Unique Identifier for the set of documents | ||||
![]() ![]() ![]() |
Σ | 0..* | Identifier | Other identifiers for the manifest | ||||
![]() ![]() ![]() |
?!Σ | 1..1 | code | current | superseded | entered-in-error Binding: DocumentReferenceStatus (required): The status of the document reference. | ||||
![]() ![]() ![]() |
Σ | 1..1 | CodeableConcept | Kind of document set Binding: ValueSetSubRecordType (MY Core) (required) | ||||
![]() ![]() ![]() |
Σ | 0..1 | Reference(Patient | Practitioner | Group | Device) | The subject of the set of documents | ||||
![]() ![]() ![]() |
0..1 | dateTime | When this document manifest created | |||||
![]() ![]() ![]() |
Σ | 0..* | Reference(Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson) | Who and/or what authored the DocumentManifest | ||||
![]() ![]() ![]() |
0..* | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Organization) | Intended to get notified about this set of documents | |||||
![]() ![]() ![]() |
0..1 | uri | The source system/application/software | |||||
![]() ![]() ![]() |
Σ | 0..1 | string | Human-readable description (title) | ||||
![]() ![]() ![]() |
Σ | 1..* | Reference(Resource) | Items in manifest | ||||
![]() ![]() ![]() |
0..* | BackboneElement | Related things | |||||
![]() ![]() ![]() ![]() |
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..1 | Identifier | Identifiers of things that are related | |||||
![]() ![]() ![]() ![]() |
0..1 | Reference(Resource) | Related Resource | |||||
![]() |
Path | Conformance | ValueSet | URI | |||
DocumentManifest.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages from the FHIR Standard
| ||||
DocumentManifest.status | required | DocumentReferenceStatushttp://hl7.org/fhir/ValueSet/document-reference-status|4.0.1 from the FHIR Standard | ||||
DocumentManifest.type | required | ValueSetSubRecordTypeMyCore (a valid code from CodeSystemSubRecordType (MY Core))http://fhir.hie.moh.gov.my/ValueSet/sub-record-type-my-core from this IG |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | DocumentManifest | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | DocumentManifest | 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 | DocumentManifest | 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 | DocumentManifest | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | DocumentManifest | 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 DocumentManifest
Other representations of profile: CSV, Excel, Schematron
This structure defines these elements as mandatory data fields:
Element | Description |
---|---|
DocumentManifest.status
|
Status of the DocumentManifest, i.e. whether it is still current or has been superseded. |
DocumentManifest.type
|
Type of DocumentManifest, e.g. maternal health record, child health record. |
DocumentManifest.content
|
List of resources that are in the DocumentManifest. |