IL Core Implementation Guide
0.18.0 - draft
This page is part of the IL-Core IG (v0.18.0: draft-1 Draft) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions
Official URL: http://fhir.health.gov.il/StructureDefinition/il-core-specimen | Version: 0.18.0 | |||
Standards status: Trial-use | Maturity Level: 1 | Computable Name: ILCoreSpecimen |
Israel Core proposed constraints and extensions on the Specimen Resource
משאב הבסיס Specimen נועד לתעד את תהליך האיסוף, התחזוקה והעיבוד של דגימה וכן את מקור הדגימה. דגימה היא כל חומר אשר נלקח מישות ביולוגית חיה או מתה או שנלקח מחפץ פיזי או מהסביבה. חלק מהדגימות הן דגימות ביולוגיות ויכולות להכיל מרכיב אחד או יותר, כולל, אך לא רק, מולקולות תאיות, תאים, רקמות, איברים, נוזלי גוף, עוברים ומוצרי הפרשת גוף
עוד מידע על פרופיל זה ניתן למצוא באתר הקהילה
משאב הבסיס Specimen נועד לתעד חומרים המשמשים לאבחון ולבדיקות סביבתיות, בנבדל מהשימוש במשאב Substance המשמש רק כאשר ההיבטים האחרים הללו אינם רלוונטיים.
משאב זה מכיל מידע בסיסי רק על מיכלי דגימה עצמם, ולא על התהליך שהמיכל עובר במעבדה. כמו כן המידע אינו מכיל מעקב אחר מיקומו של המיכל בתוך מיכל האם שלו (לדוגמה: צינור במגש במדף במקפיא). תדירות השימוש באלמנטים המתארים את המיכל תלויה בהקשר השימוש, למשל דגימה המטופלת במעבדה כללית, bio-banking וכו’.
במהלך הסדרת הפרופיל עם ארגוני הבריאות עלו מספר תרחישי שימוש שע”מ לתת להם מענה הוחלט להוסיף הרחבות (extensions) בפרופיל. להלן ההרחבות שנוספו לפרופיל, כולם אופציונאליות:
בכל משאב התואם לפרופיל ILCoreSpecimen חייבים להיות האלמנטים הבאים:
בנוסף לאלמנטים שהוגדרו כחובה, הכיתוב (MS) Must Support ליד כל אלמנט מציין שכל מערכת חייבת לתמוך גם באלמנט זה במידה והוא קיים במופע ה- Specimenשהתקבל. לחלק מהאלמנטים הוחלט להגדיר MS, ולחלק מהאלמנטים הוחלט על MS שלהם כחלק מתאימות ל- US Core כפי שמוסבר בטבלה המסכמת. להלן האלמנטים שהוגדר להם MS:
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Specimen
Path | Conformance | ValueSet | URI |
Specimen.type | extensible | ILCoreSpecimenTypehttp://fhir.health.gov.il/ValueSet/il-core-specimen-type from this IG | |
Specimen.collection.bodySite | extensible | SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-site from the FHIR Standard | |
Specimen.container.type | extensible | SpecimenContainerTypehttp://hl7.org/fhir/ValueSet/specimen-container-type from the FHIR Standard |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Specimen | 0..* | Specimen | ILCore Specimen Profile | |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
processing-location | 0..* | Reference(ILCore Location Profile) | Ext: IL Core Processing Location URL: http://fhir.health.gov.il/StructureDefinition/ext-processing-location | |
processing-practitioner | 0..* | Reference(ILCore Practitioner Profile | ILCore PractitionerRole Profile) | Ext: IL Core Processing Practitioner URL: http://fhir.health.gov.il/StructureDefinition/ext-processing-practitioner | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
status | ?!Σ | 0..1 | code | available | unavailable | unsatisfactory | entered-in-error Binding: SpecimenStatus (required): Codes providing the status/availability of a specimen. |
type | SΣ | 1..1 | CodeableConcept | Kind of material that forms the specimen Binding: IL Core Specimen type (extensible) |
subject | Σ | 0..1 | Reference(ILCore Patient Profile) | 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 |
parent | 0..* | Reference(ILCore Specimen Profile) | Specimen from which this specimen originated | |
request | 0..* | Reference(ILCore ServiceRequest Profile) | Why the specimen was collected | |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Specimen.status | required | SpecimenStatushttp://hl7.org/fhir/ValueSet/specimen-status|4.0.1 from the FHIR Standard | |
Specimen.type | extensible | ILCoreSpecimenTypehttp://fhir.health.gov.il/ValueSet/il-core-specimen-type from this IG |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Specimen | 0..* | Specimen | ILCore Specimen Profile | |||||
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 | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
processing-location | 0..* | Reference(ILCore Location Profile) | Ext: IL Core Processing Location URL: http://fhir.health.gov.il/StructureDefinition/ext-processing-location | |||||
processing-practitioner | 0..* | Reference(ILCore Practitioner Profile | ILCore PractitionerRole Profile) | Ext: IL Core Processing Practitioner URL: http://fhir.health.gov.il/StructureDefinition/ext-processing-practitioner | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | Σ | 0..* | Identifier | External Identifier | ||||
accessionIdentifier | Σ | 0..1 | Identifier | Identifier assigned by the lab | ||||
status | ?!Σ | 0..1 | code | available | unavailable | unsatisfactory | entered-in-error Binding: SpecimenStatus (required): Codes providing the status/availability of a specimen. | ||||
type | SΣ | 1..1 | CodeableConcept | Kind of material that forms the specimen Binding: IL Core Specimen type (extensible) | ||||
subject | Σ | 0..1 | Reference(ILCore Patient Profile | ILCore Group Profile | ILCore Device Profile | ILCore Substance Profile | ILCore Location Profile) | 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 | ||||
receivedTime | Σ | 0..1 | dateTime | The time when specimen was received for processing | ||||
parent | 0..* | Reference(ILCore Specimen Profile) | Specimen from which this specimen originated | |||||
request | 0..* | Reference(ILCore ServiceRequest Profile) | Why the specimen was collected | |||||
collection | 0..1 | BackboneElement | Collection details | |||||
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 | ||||
collector | Σ | 0..1 | Reference(ILCore Practitioner Profile | ILCore PractitionerRole Profile) | Who collected the specimen | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
specimen-collector | 0..1 | Reference(ILCore Patient Profile | ILCore RelatedPerson Profile) | Ext: ILCore Specimen Collector Reference URL: http://fhir.health.gov.il/StructureDefinition/ext-specimen-collector-reference | |||||
reference | ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
display | Σ | 0..1 | string | Text alternative for the resource | ||||
collected[x] | Σ | 0..1 | Collection time | |||||
collectedDateTime | dateTime | |||||||
collectedPeriod | Period | |||||||
duration | Σ | 0..1 | Duration | How long it took to collect specimen | ||||
quantity | 0..1 | SimpleQuantity | The quantity of specimen collected | |||||
method | 0..1 | CodeableConcept | Technique used to perform collection Binding: FHIRSpecimenCollectionMethod (example): The technique that is used to perform the procedure. | |||||
bodySite | 0..1 | CodeableConcept | Anatomical collection site Binding: SNOMEDCTBodyStructures (extensible): Codes describing anatomical locations. May include laterality. | |||||
fastingStatus[x] | Σ | 0..1 | Whether or how long patient abstained from food and/or drink Binding: hl7VS-relevantClincialInformation (extensible): Codes describing the fasting status of the patient. | |||||
fastingStatusCodeableConcept | CodeableConcept | |||||||
fastingStatusDuration | Duration | |||||||
processing | 0..* | BackboneElement | Processing and processing step details | |||||
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 | ||||
description | 0..1 | string | Textual description of procedure | |||||
procedure | 0..1 | CodeableConcept | Indicates the treatment step applied to the specimen Binding: SpecimenProcessingProcedure (example): Type indicating the technique used to process the specimen. | |||||
additive | 0..* | Reference(ILCore Substance Profile) | Material used in the processing step | |||||
time[x] | 0..1 | Date and time of specimen processing | ||||||
timeDateTime | dateTime | |||||||
timePeriod | Period | |||||||
container | 0..* | BackboneElement | Direct container of specimen (tube/slide, etc.) | |||||
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 | ||||
identifier | Σ | 0..* | Identifier | Id for the container | ||||
description | 0..1 | string | Textual description of the container | |||||
type | 0..1 | CodeableConcept | Kind of container directly associated with specimen Binding: SpecimenContainerType (extensible): Type of specimen container. | |||||
capacity | 0..1 | SimpleQuantity | Container volume or size | |||||
specimenQuantity | 0..1 | SimpleQuantity | Quantity of specimen within container | |||||
Slices for additive[x] | 0..1 | Additive associated with container Slice: Unordered, Open by type:$this Binding: hl7VS-additivePreservative (example): Substance added to specimen container. | ||||||
additiveCodeableConcept | CodeableConcept | |||||||
additiveReference | Reference(Substance) | |||||||
additive[x]:additiveReference | 0..1 | Reference(ILCore Substance Profile) | Additive associated with container | |||||
condition | Σ | 0..* | CodeableConcept | State of the specimen Binding: hl7VS-specimenCondition (extensible): Codes describing the state of the specimen. | ||||
note | 0..* | Annotation | Comments | |||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
Specimen.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Specimen.status | required | SpecimenStatushttp://hl7.org/fhir/ValueSet/specimen-status|4.0.1 from the FHIR Standard | ||||
Specimen.type | extensible | ILCoreSpecimenTypehttp://fhir.health.gov.il/ValueSet/il-core-specimen-type from this IG | ||||
Specimen.collection.collector.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | ||||
Specimen.collection.method | example | FHIRSpecimenCollectionMethodhttp://hl7.org/fhir/ValueSet/specimen-collection-method from the FHIR Standard | ||||
Specimen.collection.bodySite | extensible | SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-site from the FHIR Standard | ||||
Specimen.collection.fastingStatus[x] | extensible | Hl7VSRelevantClincialInformationhttp://terminology.hl7.org/ValueSet/v2-0916 | ||||
Specimen.processing.procedure | example | SpecimenProcessingProcedurehttp://hl7.org/fhir/ValueSet/specimen-processing-procedure from the FHIR Standard | ||||
Specimen.container.type | extensible | SpecimenContainerTypehttp://hl7.org/fhir/ValueSet/specimen-container-type from the FHIR Standard | ||||
Specimen.container.additive[x] | example | Hl7VSAdditivePreservativehttp://terminology.hl7.org/ValueSet/v2-0371 | ||||
Specimen.condition | extensible | Hl7VSSpecimenConditionhttp://terminology.hl7.org/ValueSet/v2-0493 |
This structure is derived from Specimen
Differential View
This structure is derived from Specimen
Path | Conformance | ValueSet | URI |
Specimen.type | extensible | ILCoreSpecimenTypehttp://fhir.health.gov.il/ValueSet/il-core-specimen-type from this IG | |
Specimen.collection.bodySite | extensible | SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-site from the FHIR Standard | |
Specimen.container.type | extensible | SpecimenContainerTypehttp://hl7.org/fhir/ValueSet/specimen-container-type from the FHIR Standard |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Specimen | 0..* | Specimen | ILCore Specimen Profile | |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
processing-location | 0..* | Reference(ILCore Location Profile) | Ext: IL Core Processing Location URL: http://fhir.health.gov.il/StructureDefinition/ext-processing-location | |
processing-practitioner | 0..* | Reference(ILCore Practitioner Profile | ILCore PractitionerRole Profile) | Ext: IL Core Processing Practitioner URL: http://fhir.health.gov.il/StructureDefinition/ext-processing-practitioner | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
status | ?!Σ | 0..1 | code | available | unavailable | unsatisfactory | entered-in-error Binding: SpecimenStatus (required): Codes providing the status/availability of a specimen. |
type | SΣ | 1..1 | CodeableConcept | Kind of material that forms the specimen Binding: IL Core Specimen type (extensible) |
subject | Σ | 0..1 | Reference(ILCore Patient Profile) | 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 |
parent | 0..* | Reference(ILCore Specimen Profile) | Specimen from which this specimen originated | |
request | 0..* | Reference(ILCore ServiceRequest Profile) | Why the specimen was collected | |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Specimen.status | required | SpecimenStatushttp://hl7.org/fhir/ValueSet/specimen-status|4.0.1 from the FHIR Standard | |
Specimen.type | extensible | ILCoreSpecimenTypehttp://fhir.health.gov.il/ValueSet/il-core-specimen-type from this IG |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Specimen | 0..* | Specimen | ILCore Specimen Profile | |||||
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 | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
processing-location | 0..* | Reference(ILCore Location Profile) | Ext: IL Core Processing Location URL: http://fhir.health.gov.il/StructureDefinition/ext-processing-location | |||||
processing-practitioner | 0..* | Reference(ILCore Practitioner Profile | ILCore PractitionerRole Profile) | Ext: IL Core Processing Practitioner URL: http://fhir.health.gov.il/StructureDefinition/ext-processing-practitioner | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | Σ | 0..* | Identifier | External Identifier | ||||
accessionIdentifier | Σ | 0..1 | Identifier | Identifier assigned by the lab | ||||
status | ?!Σ | 0..1 | code | available | unavailable | unsatisfactory | entered-in-error Binding: SpecimenStatus (required): Codes providing the status/availability of a specimen. | ||||
type | SΣ | 1..1 | CodeableConcept | Kind of material that forms the specimen Binding: IL Core Specimen type (extensible) | ||||
subject | Σ | 0..1 | Reference(ILCore Patient Profile | ILCore Group Profile | ILCore Device Profile | ILCore Substance Profile | ILCore Location Profile) | 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 | ||||
receivedTime | Σ | 0..1 | dateTime | The time when specimen was received for processing | ||||
parent | 0..* | Reference(ILCore Specimen Profile) | Specimen from which this specimen originated | |||||
request | 0..* | Reference(ILCore ServiceRequest Profile) | Why the specimen was collected | |||||
collection | 0..1 | BackboneElement | Collection details | |||||
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 | ||||
collector | Σ | 0..1 | Reference(ILCore Practitioner Profile | ILCore PractitionerRole Profile) | Who collected the specimen | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
specimen-collector | 0..1 | Reference(ILCore Patient Profile | ILCore RelatedPerson Profile) | Ext: ILCore Specimen Collector Reference URL: http://fhir.health.gov.il/StructureDefinition/ext-specimen-collector-reference | |||||
reference | ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
display | Σ | 0..1 | string | Text alternative for the resource | ||||
collected[x] | Σ | 0..1 | Collection time | |||||
collectedDateTime | dateTime | |||||||
collectedPeriod | Period | |||||||
duration | Σ | 0..1 | Duration | How long it took to collect specimen | ||||
quantity | 0..1 | SimpleQuantity | The quantity of specimen collected | |||||
method | 0..1 | CodeableConcept | Technique used to perform collection Binding: FHIRSpecimenCollectionMethod (example): The technique that is used to perform the procedure. | |||||
bodySite | 0..1 | CodeableConcept | Anatomical collection site Binding: SNOMEDCTBodyStructures (extensible): Codes describing anatomical locations. May include laterality. | |||||
fastingStatus[x] | Σ | 0..1 | Whether or how long patient abstained from food and/or drink Binding: hl7VS-relevantClincialInformation (extensible): Codes describing the fasting status of the patient. | |||||
fastingStatusCodeableConcept | CodeableConcept | |||||||
fastingStatusDuration | Duration | |||||||
processing | 0..* | BackboneElement | Processing and processing step details | |||||
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 | ||||
description | 0..1 | string | Textual description of procedure | |||||
procedure | 0..1 | CodeableConcept | Indicates the treatment step applied to the specimen Binding: SpecimenProcessingProcedure (example): Type indicating the technique used to process the specimen. | |||||
additive | 0..* | Reference(ILCore Substance Profile) | Material used in the processing step | |||||
time[x] | 0..1 | Date and time of specimen processing | ||||||
timeDateTime | dateTime | |||||||
timePeriod | Period | |||||||
container | 0..* | BackboneElement | Direct container of specimen (tube/slide, etc.) | |||||
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 | ||||
identifier | Σ | 0..* | Identifier | Id for the container | ||||
description | 0..1 | string | Textual description of the container | |||||
type | 0..1 | CodeableConcept | Kind of container directly associated with specimen Binding: SpecimenContainerType (extensible): Type of specimen container. | |||||
capacity | 0..1 | SimpleQuantity | Container volume or size | |||||
specimenQuantity | 0..1 | SimpleQuantity | Quantity of specimen within container | |||||
Slices for additive[x] | 0..1 | Additive associated with container Slice: Unordered, Open by type:$this Binding: hl7VS-additivePreservative (example): Substance added to specimen container. | ||||||
additiveCodeableConcept | CodeableConcept | |||||||
additiveReference | Reference(Substance) | |||||||
additive[x]:additiveReference | 0..1 | Reference(ILCore Substance Profile) | Additive associated with container | |||||
condition | Σ | 0..* | CodeableConcept | State of the specimen Binding: hl7VS-specimenCondition (extensible): Codes describing the state of the specimen. | ||||
note | 0..* | Annotation | Comments | |||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
Specimen.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Specimen.status | required | SpecimenStatushttp://hl7.org/fhir/ValueSet/specimen-status|4.0.1 from the FHIR Standard | ||||
Specimen.type | extensible | ILCoreSpecimenTypehttp://fhir.health.gov.il/ValueSet/il-core-specimen-type from this IG | ||||
Specimen.collection.collector.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | ||||
Specimen.collection.method | example | FHIRSpecimenCollectionMethodhttp://hl7.org/fhir/ValueSet/specimen-collection-method from the FHIR Standard | ||||
Specimen.collection.bodySite | extensible | SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-site from the FHIR Standard | ||||
Specimen.collection.fastingStatus[x] | extensible | Hl7VSRelevantClincialInformationhttp://terminology.hl7.org/ValueSet/v2-0916 | ||||
Specimen.processing.procedure | example | SpecimenProcessingProcedurehttp://hl7.org/fhir/ValueSet/specimen-processing-procedure from the FHIR Standard | ||||
Specimen.container.type | extensible | SpecimenContainerTypehttp://hl7.org/fhir/ValueSet/specimen-container-type from the FHIR Standard | ||||
Specimen.container.additive[x] | example | Hl7VSAdditivePreservativehttp://terminology.hl7.org/ValueSet/v2-0371 | ||||
Specimen.condition | extensible | Hl7VSSpecimenConditionhttp://terminology.hl7.org/ValueSet/v2-0493 |
This structure is derived from Specimen
Other representations of profile: CSV, Excel, Schematron