NHDR Implementation Guide Release 1.0
0.1.0 - ci-build
NHDR Implementation Guide Release 1.0, published by NHDR. 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/PROJ-PHILHEALTH-EA-NHDR/PhilHealth-NHDR-IG-Review/ and changes regularly. See the Directory of published versions
Official URL: https://nhdr.gov.ph/fhir/StructureDefinition/PH-Specimen | Version: 0.1.0 | |||
Standards status: Draft | Computable Name: PH_Specimen | |||
Copyright/Legal: Used by permission of HL7 International, all rights reserved Creative Commons License |
A sample to be used for analysis.
Usages:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
Path | Conformance | ValueSet | URI |
Specimen.type | required | Hl7VSSpecimenTypehttp://terminology.hl7.org/ValueSet/v2-0487 | |
Specimen.condition | required | Hl7VSSpecimenConditionhttp://terminology.hl7.org/ValueSet/v2-0493 |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Specimen | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Specimen | 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 | Specimen | 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 | Specimen | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Specimen | 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 Specimen
Path | Conformance | ValueSet | URI |
Specimen.type | required | Hl7VSSpecimenTypehttp://terminology.hl7.org/ValueSet/v2-0487 | |
Specimen.condition | required | Hl7VSSpecimenConditionhttp://terminology.hl7.org/ValueSet/v2-0493 |
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
0..* | Specimen | Sample for analysis | |
![]() ![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact |
![]() ![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource |
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() |
0..* | dateTime | Date recorded URL: https://nhdr.gov.ph/fhir/StructureDefinition/RecordedDate | |
![]() ![]() ![]() ![]() |
Σ | 0..1 | id | Version specific identifier |
![]() ![]() ![]() ![]() |
Σ | 0..1 | instant | When the resource version last changed |
![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | Identifies where the resource comes from |
![]() ![]() ![]() ![]() |
Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to |
![]() ![]() ![]() ![]() |
Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. |
![]() ![]() ![]() ![]() |
Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". |
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
0..* | dateTime | Date of result URL: https://nhdr.gov.ph/fhir/StructureDefinition/ResultDate | |
![]() ![]() ![]() ![]() |
0..* | base64Binary, boolean, canonical(), code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference(), SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta | Type of species URL: https://nhdr.gov.ph/fhir/StructureDefinition/Species | |
![]() ![]() ![]() |
Σ | 0..* | Identifier | External Identifier |
![]() ![]() ![]() |
Σ | 0..1 | Identifier | Identifier assigned by the lab |
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Kind of material that forms the specimen Binding: hl7VS-specimenType (required) |
![]() ![]() ![]() |
Σ | 0..1 | Reference(PH Patient) | Where the specimen came from. This may be from patient(s), from a location (e.g., the source of an environmental sample), or a sampling of a substance or a device |
![]() ![]() ![]() |
Σ | 0..1 | dateTime | The time when specimen was received for processing |
![]() ![]() ![]() |
0..1 | BackboneElement | Collection details | |
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() |
0..* | dateTime | Date the specimen was released URL: https://nhdr.gov.ph/fhir/StructureDefinition/DateReleased | |
![]() ![]() ![]() ![]() |
Σ | 0..1 | Reference(PH Practitioner | PH PractitionerRole) | Who collected the specimen |
![]() ![]() ![]() ![]() |
Σ | 0..1 | dateTime | Collection time |
![]() ![]() ![]() ![]() |
0..1 | SimpleQuantity | The quantity of specimen collected | |
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Technique used to perform collection Binding: FHIRSpecimenCollectionMethod (example): The technique that is used to perform the procedure. | |
![]() ![]() ![]() |
0..* | BackboneElement | Processing and processing step details | |
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Indicates the treatment step applied to the specimen Binding: SpecimenProcessingProcedure (example): Type indicating the technique used to process the specimen. | |
![]() ![]() ![]() ![]() |
0..1 | Date and time of specimen processing | ||
![]() ![]() ![]() ![]() ![]() |
dateTime | |||
![]() ![]() ![]() ![]() ![]() |
Period | |||
![]() ![]() ![]() |
0..* | BackboneElement | Direct container of specimen (tube/slide, etc.) | |
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Kind of container directly associated with specimen Binding: SpecimenContainerType (example): Type of specimen container. | |
![]() ![]() ![]() ![]() |
0..1 | SimpleQuantity | Quantity of specimen within container | |
![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | State of the specimen Binding: hl7VS-specimenCondition (required) |
![]() ![]() ![]() |
0..* | Annotation | Comments | |
![]() |
Path | Conformance | ValueSet | URI |
Specimen.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels From the FHIR Standard | |
Specimen.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tags From the FHIR Standard | |
Specimen.type | required | Hl7VSSpecimenTypehttp://terminology.hl7.org/ValueSet/v2-0487 | |
Specimen.collection.method | example | FHIRSpecimenCollectionMethodhttp://hl7.org/fhir/ValueSet/specimen-collection-method From the FHIR Standard | |
Specimen.processing.procedure | example | SpecimenProcessingProcedurehttp://hl7.org/fhir/ValueSet/specimen-processing-procedure From the FHIR Standard | |
Specimen.container.type | example | SpecimenContainerTypehttp://hl7.org/fhir/ValueSet/specimen-container-type From the FHIR Standard | |
Specimen.condition | required | Hl7VSSpecimenConditionhttp://terminology.hl7.org/ValueSet/v2-0493 |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Specimen | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Specimen | 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 | Specimen | 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 | Specimen | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Specimen | 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 Specimen
Summary
Prohibited: 24 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Key Elements View
Path | Conformance | ValueSet | URI |
Specimen.type | required | Hl7VSSpecimenTypehttp://terminology.hl7.org/ValueSet/v2-0487 | |
Specimen.condition | required | Hl7VSSpecimenConditionhttp://terminology.hl7.org/ValueSet/v2-0493 |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Specimen | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Specimen | 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 | Specimen | 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 | Specimen | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Specimen | 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 Specimen
Path | Conformance | ValueSet | URI |
Specimen.type | required | Hl7VSSpecimenTypehttp://terminology.hl7.org/ValueSet/v2-0487 | |
Specimen.condition | required | Hl7VSSpecimenConditionhttp://terminology.hl7.org/ValueSet/v2-0493 |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
0..* | Specimen | Sample for analysis | |
![]() ![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact |
![]() ![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource |
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() |
0..* | dateTime | Date recorded URL: https://nhdr.gov.ph/fhir/StructureDefinition/RecordedDate | |
![]() ![]() ![]() ![]() |
Σ | 0..1 | id | Version specific identifier |
![]() ![]() ![]() ![]() |
Σ | 0..1 | instant | When the resource version last changed |
![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | Identifies where the resource comes from |
![]() ![]() ![]() ![]() |
Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to |
![]() ![]() ![]() ![]() |
Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. |
![]() ![]() ![]() ![]() |
Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". |
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
0..* | dateTime | Date of result URL: https://nhdr.gov.ph/fhir/StructureDefinition/ResultDate | |
![]() ![]() ![]() ![]() |
0..* | base64Binary, boolean, canonical(), code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference(), SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta | Type of species URL: https://nhdr.gov.ph/fhir/StructureDefinition/Species | |
![]() ![]() ![]() |
Σ | 0..* | Identifier | External Identifier |
![]() ![]() ![]() |
Σ | 0..1 | Identifier | Identifier assigned by the lab |
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Kind of material that forms the specimen Binding: hl7VS-specimenType (required) |
![]() ![]() ![]() |
Σ | 0..1 | Reference(PH Patient) | Where the specimen came from. This may be from patient(s), from a location (e.g., the source of an environmental sample), or a sampling of a substance or a device |
![]() ![]() ![]() |
Σ | 0..1 | dateTime | The time when specimen was received for processing |
![]() ![]() ![]() |
0..1 | BackboneElement | Collection details | |
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() |
0..* | dateTime | Date the specimen was released URL: https://nhdr.gov.ph/fhir/StructureDefinition/DateReleased | |
![]() ![]() ![]() ![]() |
Σ | 0..1 | Reference(PH Practitioner | PH PractitionerRole) | Who collected the specimen |
![]() ![]() ![]() ![]() |
Σ | 0..1 | dateTime | Collection time |
![]() ![]() ![]() ![]() |
0..1 | SimpleQuantity | The quantity of specimen collected | |
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Technique used to perform collection Binding: FHIRSpecimenCollectionMethod (example): The technique that is used to perform the procedure. | |
![]() ![]() ![]() |
0..* | BackboneElement | Processing and processing step details | |
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Indicates the treatment step applied to the specimen Binding: SpecimenProcessingProcedure (example): Type indicating the technique used to process the specimen. | |
![]() ![]() ![]() ![]() |
0..1 | Date and time of specimen processing | ||
![]() ![]() ![]() ![]() ![]() |
dateTime | |||
![]() ![]() ![]() ![]() ![]() |
Period | |||
![]() ![]() ![]() |
0..* | BackboneElement | Direct container of specimen (tube/slide, etc.) | |
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Kind of container directly associated with specimen Binding: SpecimenContainerType (example): Type of specimen container. | |
![]() ![]() ![]() ![]() |
0..1 | SimpleQuantity | Quantity of specimen within container | |
![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | State of the specimen Binding: hl7VS-specimenCondition (required) |
![]() ![]() ![]() |
0..* | Annotation | Comments | |
![]() |
Path | Conformance | ValueSet | URI |
Specimen.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels From the FHIR Standard | |
Specimen.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tags From the FHIR Standard | |
Specimen.type | required | Hl7VSSpecimenTypehttp://terminology.hl7.org/ValueSet/v2-0487 | |
Specimen.collection.method | example | FHIRSpecimenCollectionMethodhttp://hl7.org/fhir/ValueSet/specimen-collection-method From the FHIR Standard | |
Specimen.processing.procedure | example | SpecimenProcessingProcedurehttp://hl7.org/fhir/ValueSet/specimen-processing-procedure From the FHIR Standard | |
Specimen.container.type | example | SpecimenContainerTypehttp://hl7.org/fhir/ValueSet/specimen-container-type From the FHIR Standard | |
Specimen.condition | required | Hl7VSSpecimenConditionhttp://terminology.hl7.org/ValueSet/v2-0493 |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Specimen | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Specimen | 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 | Specimen | 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 | Specimen | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Specimen | 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 Specimen
Summary
Prohibited: 24 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Other representations of profile: CSV, Excel, Schematron