Hospital-Community Lab Referral Cycle
1.1.0 - ci-build
This page is part of the LRC IG (v1.1.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://ig.fhir-il-community.org/LRC/StructureDefinition/lrc-referral | Version: 1.1.0 | |||
Active as of 2024-08-12 | Computable Name: LrcReferral |
הפניה לבדיקת מעבדה, או לפאנל (סוללה) של בדיקות מעבדה. משאב זה בפני עצמו אינו מהווה טריגר לתחילת הטיפול בהפניה, אלא יטופל רק במסגרת referral group.
פרופיל המייצג הפניה לבדיקת מעבדה, או לפאנל (סוללה) של בדיקות מעבדה, באמצעות ServiceRequest.כל בדיקת מעבדה מיוצגת באמצעות הפניה בודדת. המקרה היחיד בו הפניה תייצג יותרמבדיקת מעבדה אחת הינו פאנל, אשר קוד בודד שלה מייצג מספר קודי הפניות.הפרופיל הנ"ל מתבסס על הפרופיל הישראלי: ILCoreServiceRequest.בנוסף להגדרות קארדינליות ושמירת הקשר לפרופילים נוספים של IL-Core, הפרופיל גם מגדיר רשימתערכים בסיסית הניתנת להרחבה אך מחייבת שלכל ערך יהיה קוד ממערכת קידוד Loinc, לצורך שמירה על האינטראופרביליות של המידע הומעבר. לכן, בכל יישום של הפרופיל יש ליצור טבלת המרה בין הקודים המקומיים של שני הארגונים, לבין קודי Loinc המוסכמים על ידי שני הצדדים, ובמקביל לוודא שהערכים תואמים אתערכי הרשימה (ValueSet) ששוייכה לפרופיל. לפרטים נוספים אודות רשימת הערכים- ר' LrcReferralCodes.
משאב ServiceRequest נוצר עם סטאטוס "active". רק משאבים בסטאטוס זה יטופלו על ידי הקהילה.
רלוונטיגם להפניה בודדת וגם להפניה מאגדת.
רשימת ערכי Loinc אשר כוללת מקבץ קודי הפניה עבור בדיקות מעבדה אפשריות. היא רלוונטית עבור אלמנט: ServiceRequest.code, בפרופיל: LRC Lab Test Referral.
הרשימה מוגדרת עם binding מסוג extensible, כלומר ניתן להרחיב את הרשימה לערכים נוספים, על פי הצורך. בתוך הרשימה נכללים קודים של הפניות בודדות וכן קודים של פאנלים (סוללות), כיוון שאופן השימוש בשני סוגי הקודים הינו זהה ושניהם ממומשים באמצעות אותו הפרופיל (LRC Lab Test Referral). לעומת זאת, קודי ההפניה של הפאנלים (הקודים הספציפיים הכלולים בקבוצת הפאנל), הם אינם חלק מרשימת הערכים הזו, מכיוון שלא נוצרת עבורם הפניה נפרדת. הם מיוצגים בהפניה באמצעות קוד הפאנל בלבד.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from ILCoreServiceRequest
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
ServiceRequest | ILCoreServiceRequest | |||||||
identifier | 1..* | Identifier | Identifiers assigned to this order | |||||
system | 1..1 | uri | The namespace for the identifier value | |||||
value | 1..1 | string | The value that is unique | |||||
intent | 1..1 | code | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option Fixed Value: order | |||||
Slices for category | Content/Rules for all slices | |||||||
category:il-core | 0..* | CodeableConcept | Classification of service Required Pattern: At least the following | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 108252007 | |||||
display | 1..1 | string | Representation defined by the system Fixed Value: Laboratory procedure | |||||
code | 1..1 | CodeableConcept | What is being requested/ordered Binding: Lrc Referral Codes (extensible)
| |||||
coding | ||||||||
system | 1..1 | uri | Identity of the terminology system | |||||
code | 1..1 | code | Symbol in syntax defined by the system | |||||
subject | 1..1 | Reference(ILCore Patient Profile) | Individual or Entity the service is ordered for | |||||
requester | 1..1 | Reference(ILCore Practitioner Profile | ILCore PractitionerRole Profile | ILCore Organization Profile | ILCore Patient Profile | ILCore RelatedPerson Profile | ILCore Device Profile) | Who/what is requesting service | |||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
ServiceRequest.code | extensible | LrcReferralCodes
http://ig.fhir-il-community.org/LRC/ValueSet/lrc-referral-codes from this IG |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
ServiceRequest | C | 0..* | ILCoreServiceRequest | ILCore ServiceRequest Profile prr-1: orderDetail SHALL only be present if code is present | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | Σ | 1..* | Identifier | Identifiers assigned to this order | ||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
system | Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
value | Σ | 1..1 | string | The value that is unique Example General: 123456 | ||||
status | ?!SΣ | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): The status of a service order. | ||||
intent | ?!SΣ | 1..1 | code | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option Binding: RequestIntent (required): The kind of service request. Fixed Value: order | ||||
Slices for category | SΣ | 1..* | CodeableConcept | Classification of service Slice: Unordered, Open by pattern:$this Binding: IL Core ServiceCategory (extensible) | ||||
category:il-core | Σ | 0..* | CodeableConcept | Classification of service Binding: IL Core ServiceCategory (required) Required Pattern: At least the following | ||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 108252007 | |||||
display | 1..1 | string | Representation defined by the system Fixed Value: Laboratory procedure | |||||
doNotPerform | ?!Σ | 0..1 | boolean | True if service/procedure should not be performed | ||||
code | SΣ | 1..1 | CodeableConcept | What is being requested/ordered Binding: Lrc Referral Codes (extensible)
| ||||
subject | SΣ | 1..1 | Reference(ILCore Patient Profile) | Individual or Entity the service is ordered for | ||||
Slices for occurrence[x] | SΣ | 0..1 | When service should occur Slice: Unordered, Open by type:$this | |||||
occurrenceDateTime | dateTime | |||||||
occurrencePeriod | Period | |||||||
occurrenceTiming | Timing | |||||||
occurrence[x]:occurrenceDateTime | SΣ | 0..1 | dateTime | When service should occur | ||||
Slices for extension | Content/Rules for all slices | |||||||
relative-date | 0..1 | (Complex) | Extension: Relative Date Criteria URL: http://hl7.org/fhir/StructureDefinition/relative-date | |||||
occurrence[x]:occurrencePeriod | SΣ | 0..1 | Period | When service should occur | ||||
authoredOn | SΣ | 0..1 | dateTime | Date request signed | ||||
requester | SΣ | 1..1 | Reference(ILCore Practitioner Profile | ILCore PractitionerRole Profile | ILCore Organization Profile | ILCore Patient Profile | ILCore RelatedPerson Profile | ILCore Device Profile) | Who/what is requesting service | ||||
reasonCode | SΣ | 0..* | CodeableConcept | Explanation/Justification for procedure or service Binding: IL Core procedure Reason (extensible) | ||||
Documentation for this format |
Path | Conformance | ValueSet / Code | URI | |||
ServiceRequest.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
ServiceRequest.status | required | RequestStatushttp://hl7.org/fhir/ValueSet/request-status|4.0.1 from the FHIR Standard | ||||
ServiceRequest.intent | required | Fixed Value: orderhttp://hl7.org/fhir/ValueSet/request-intent|4.0.1 from the FHIR Standard | ||||
ServiceRequest.category | extensible | ILCoreServiceCategoryhttp://fhir.health.gov.il/ValueSet/il-core-service-category | ||||
ServiceRequest.category:il-core | required | Pattern: SNOMED-CT Code 108252007("Laboratory procedure")http://fhir.health.gov.il/ValueSet/il-core-service-category | ||||
ServiceRequest.code | extensible | LrcReferralCodes
http://ig.fhir-il-community.org/LRC/ValueSet/lrc-referral-codes from this IG | ||||
ServiceRequest.reasonCode | extensible | ILCoreProcedureReasonhttp://fhir.health.gov.il/ValueSet/il-core-procedure-reason |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | ServiceRequest | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | ServiceRequest | 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 | ServiceRequest | 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 | ServiceRequest | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | ServiceRequest | 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() | |
prr-1 | error | ServiceRequest | orderDetail SHALL only be present if code is present : orderDetail.empty() or code.exists() |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
ServiceRequest | C | 0..* | ILCoreServiceRequest | ILCore ServiceRequest Profile prr-1: orderDetail SHALL only be present if code is present | ||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 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 | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | Σ | 1..* | Identifier | Identifiers assigned to this order | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
system | Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
value | Σ | 1..1 | string | The value that is unique Example General: 123456 | ||||
period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
instantiatesCanonical | Σ | 0..* | canonical(ActivityDefinition | PlanDefinition) | Instantiates FHIR protocol or definition | ||||
instantiatesUri | Σ | 0..* | uri | Instantiates external protocol or definition | ||||
basedOn | Σ | 0..* | Reference(CarePlan | ILCore ServiceRequest Profile | ILCore MedicationRequest Profile) | What request fulfills | ||||
replaces | Σ | 0..* | Reference(ILCore ServiceRequest Profile) | What request replaces | ||||
requisition | Σ | 0..1 | Identifier | Composite Request ID | ||||
status | ?!SΣ | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): The status of a service order. | ||||
intent | ?!SΣ | 1..1 | code | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option Binding: RequestIntent (required): The kind of service request. Fixed Value: order | ||||
Slices for category | SΣ | 1..* | CodeableConcept | Classification of service Slice: Unordered, Open by pattern:$this Binding: IL Core ServiceCategory (extensible) | ||||
category:il-core | Σ | 0..* | CodeableConcept | Classification of service Binding: IL Core ServiceCategory (required) Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 108252007 | |||||
display | 1..1 | string | Representation defined by the system Fixed Value: Laboratory procedure | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 1..1 | uri | Identity of the terminology system Required Pattern: http://snomed.info/sct | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 1..1 | code | Symbol in syntax defined by the system | ||||
display | Σ | 1..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
priority | Σ | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request. | ||||
doNotPerform | ?!Σ | 0..1 | boolean | True if service/procedure should not be performed | ||||
code | SΣ | 1..1 | CodeableConcept | What is being requested/ordered Binding: Lrc Referral Codes (extensible)
| ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 1..1 | uri | Identity of the terminology system | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 1..1 | code | Symbol in syntax defined by the system | ||||
display | Σ | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
orderDetail | ΣC | 0..* | CodeableConcept | Additional order information Binding: ServiceRequestOrderDetailsCodes (example): Codified order entry details which are based on order context. | ||||
quantity[x] | Σ | 0..1 | Service amount | |||||
quantityQuantity | Quantity | |||||||
quantityRatio | Ratio | |||||||
quantityRange | Range | |||||||
subject | SΣ | 1..1 | Reference(ILCore Patient Profile) | Individual or Entity the service is ordered for | ||||
encounter | Σ | 0..1 | Reference(ILCore Encounter Profile) | Encounter in which the request was created | ||||
Slices for occurrence[x] | SΣ | 0..1 | When service should occur Slice: Unordered, Open by type:$this | |||||
occurrenceDateTime | dateTime | |||||||
occurrencePeriod | Period | |||||||
occurrenceTiming | Timing | |||||||
occurrence[x]:occurrenceDateTime | SΣ | 0..1 | dateTime | When service should occur | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
relative-date | 0..1 | (Complex) | Extension: Relative Date Criteria URL: http://hl7.org/fhir/StructureDefinition/relative-date | |||||
value | 0..1 | dateTime | Primitive value for dateTime | |||||
occurrence[x]:occurrencePeriod | SΣ | 0..1 | Period | When service should occur | ||||
asNeeded[x] | Σ | 0..1 | Preconditions for service Binding: SNOMEDCTMedicationAsNeededReasonCodes (example): A coded concept identifying the pre-condition that should hold prior to performing a procedure. For example "pain", "on flare-up", etc. | |||||
asNeededBoolean | boolean | |||||||
asNeededCodeableConcept | CodeableConcept | |||||||
authoredOn | SΣ | 0..1 | dateTime | Date request signed | ||||
requester | SΣ | 1..1 | Reference(ILCore Practitioner Profile | ILCore PractitionerRole Profile | ILCore Organization Profile | ILCore Patient Profile | ILCore RelatedPerson Profile | ILCore Device Profile) | Who/what is requesting service | ||||
performerType | Σ | 0..1 | CodeableConcept | Performer role Binding: ParticipantRoles (example): Indicates specific responsibility of an individual within the care team, such as "Primary physician", "Team coordinator", "Caregiver", etc. | ||||
performer | Σ | 0..* | Reference(ILCore Practitioner Profile | ILCore PractitionerRole Profile | ILCore Organization Profile | CareTeam | HealthcareService | ILCore Patient Profile | ILCore Device Profile | ILCore RelatedPerson Profile) | Requested performer | ||||
locationCode | Σ | 0..* | CodeableConcept | Requested location Binding: ServiceDeliveryLocationRoleType (example): A location type where services are delivered. | ||||
locationReference | Σ | 0..* | Reference(ILCore Location Profile) | Requested location | ||||
reasonCode | SΣ | 0..* | CodeableConcept | Explanation/Justification for procedure or service Binding: IL Core procedure Reason (extensible) | ||||
reasonReference | Σ | 0..* | Reference(ILCore Condition Profile | ILCore Observation Profile | ILCore DiagnosticReport Profile | DocumentReference) | Explanation/Justification for service or service | ||||
insurance | 0..* | Reference(Coverage | ClaimResponse) | Associated insurance coverage | |||||
supportingInfo | 0..* | Reference(Resource) | Additional clinical information | |||||
specimen | Σ | 0..* | Reference(ILCore Specimen Profile) | Procedure Samples | ||||
bodySite | Σ | 0..* | CodeableConcept | Location on Body Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. | ||||
note | 0..* | Annotation | Comments | |||||
patientInstruction | Σ | 0..1 | string | Patient or consumer-oriented instructions | ||||
relevantHistory | 0..* | Reference(Provenance) | Request provenance | |||||
Documentation for this format |
Path | Conformance | ValueSet / Code | URI | |||
ServiceRequest.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
ServiceRequest.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
ServiceRequest.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
ServiceRequest.status | required | RequestStatushttp://hl7.org/fhir/ValueSet/request-status|4.0.1 from the FHIR Standard | ||||
ServiceRequest.intent | required | Fixed Value: orderhttp://hl7.org/fhir/ValueSet/request-intent|4.0.1 from the FHIR Standard | ||||
ServiceRequest.category | extensible | ILCoreServiceCategoryhttp://fhir.health.gov.il/ValueSet/il-core-service-category | ||||
ServiceRequest.category:il-core | required | Pattern: SNOMED-CT Code 108252007("Laboratory procedure")http://fhir.health.gov.il/ValueSet/il-core-service-category | ||||
ServiceRequest.priority | required | RequestPriorityhttp://hl7.org/fhir/ValueSet/request-priority|4.0.1 from the FHIR Standard | ||||
ServiceRequest.code | extensible | LrcReferralCodes
http://ig.fhir-il-community.org/LRC/ValueSet/lrc-referral-codes from this IG | ||||
ServiceRequest.orderDetail | example | ServiceRequestOrderDetailsCodeshttp://hl7.org/fhir/ValueSet/servicerequest-orderdetail from the FHIR Standard | ||||
ServiceRequest.asNeeded[x] | example | SNOMEDCTMedicationAsNeededReasonCodeshttp://hl7.org/fhir/ValueSet/medication-as-needed-reason from the FHIR Standard | ||||
ServiceRequest.performerType | example | ParticipantRoleshttp://hl7.org/fhir/ValueSet/participant-role from the FHIR Standard | ||||
ServiceRequest.locationCode | example | ServiceDeliveryLocationRoleTypehttp://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType | ||||
ServiceRequest.reasonCode | extensible | ILCoreProcedureReasonhttp://fhir.health.gov.il/ValueSet/il-core-procedure-reason | ||||
ServiceRequest.bodySite | example | SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-site from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | ServiceRequest | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | ServiceRequest | 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 | ServiceRequest | 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 | ServiceRequest | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | ServiceRequest | 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() | |
prr-1 | error | ServiceRequest | orderDetail SHALL only be present if code is present : orderDetail.empty() or code.exists() |
This structure is derived from ILCoreServiceRequest
Differential View
This structure is derived from ILCoreServiceRequest
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
ServiceRequest | ILCoreServiceRequest | |||||||
identifier | 1..* | Identifier | Identifiers assigned to this order | |||||
system | 1..1 | uri | The namespace for the identifier value | |||||
value | 1..1 | string | The value that is unique | |||||
intent | 1..1 | code | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option Fixed Value: order | |||||
Slices for category | Content/Rules for all slices | |||||||
category:il-core | 0..* | CodeableConcept | Classification of service Required Pattern: At least the following | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 108252007 | |||||
display | 1..1 | string | Representation defined by the system Fixed Value: Laboratory procedure | |||||
code | 1..1 | CodeableConcept | What is being requested/ordered Binding: Lrc Referral Codes (extensible)
| |||||
coding | ||||||||
system | 1..1 | uri | Identity of the terminology system | |||||
code | 1..1 | code | Symbol in syntax defined by the system | |||||
subject | 1..1 | Reference(ILCore Patient Profile) | Individual or Entity the service is ordered for | |||||
requester | 1..1 | Reference(ILCore Practitioner Profile | ILCore PractitionerRole Profile | ILCore Organization Profile | ILCore Patient Profile | ILCore RelatedPerson Profile | ILCore Device Profile) | Who/what is requesting service | |||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
ServiceRequest.code | extensible | LrcReferralCodes
http://ig.fhir-il-community.org/LRC/ValueSet/lrc-referral-codes from this IG |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
ServiceRequest | C | 0..* | ILCoreServiceRequest | ILCore ServiceRequest Profile prr-1: orderDetail SHALL only be present if code is present | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | Σ | 1..* | Identifier | Identifiers assigned to this order | ||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
system | Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
value | Σ | 1..1 | string | The value that is unique Example General: 123456 | ||||
status | ?!SΣ | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): The status of a service order. | ||||
intent | ?!SΣ | 1..1 | code | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option Binding: RequestIntent (required): The kind of service request. Fixed Value: order | ||||
Slices for category | SΣ | 1..* | CodeableConcept | Classification of service Slice: Unordered, Open by pattern:$this Binding: IL Core ServiceCategory (extensible) | ||||
category:il-core | Σ | 0..* | CodeableConcept | Classification of service Binding: IL Core ServiceCategory (required) Required Pattern: At least the following | ||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 108252007 | |||||
display | 1..1 | string | Representation defined by the system Fixed Value: Laboratory procedure | |||||
doNotPerform | ?!Σ | 0..1 | boolean | True if service/procedure should not be performed | ||||
code | SΣ | 1..1 | CodeableConcept | What is being requested/ordered Binding: Lrc Referral Codes (extensible)
| ||||
subject | SΣ | 1..1 | Reference(ILCore Patient Profile) | Individual or Entity the service is ordered for | ||||
Slices for occurrence[x] | SΣ | 0..1 | When service should occur Slice: Unordered, Open by type:$this | |||||
occurrenceDateTime | dateTime | |||||||
occurrencePeriod | Period | |||||||
occurrenceTiming | Timing | |||||||
occurrence[x]:occurrenceDateTime | SΣ | 0..1 | dateTime | When service should occur | ||||
Slices for extension | Content/Rules for all slices | |||||||
relative-date | 0..1 | (Complex) | Extension: Relative Date Criteria URL: http://hl7.org/fhir/StructureDefinition/relative-date | |||||
occurrence[x]:occurrencePeriod | SΣ | 0..1 | Period | When service should occur | ||||
authoredOn | SΣ | 0..1 | dateTime | Date request signed | ||||
requester | SΣ | 1..1 | Reference(ILCore Practitioner Profile | ILCore PractitionerRole Profile | ILCore Organization Profile | ILCore Patient Profile | ILCore RelatedPerson Profile | ILCore Device Profile) | Who/what is requesting service | ||||
reasonCode | SΣ | 0..* | CodeableConcept | Explanation/Justification for procedure or service Binding: IL Core procedure Reason (extensible) | ||||
Documentation for this format |
Path | Conformance | ValueSet / Code | URI | |||
ServiceRequest.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
ServiceRequest.status | required | RequestStatushttp://hl7.org/fhir/ValueSet/request-status|4.0.1 from the FHIR Standard | ||||
ServiceRequest.intent | required | Fixed Value: orderhttp://hl7.org/fhir/ValueSet/request-intent|4.0.1 from the FHIR Standard | ||||
ServiceRequest.category | extensible | ILCoreServiceCategoryhttp://fhir.health.gov.il/ValueSet/il-core-service-category | ||||
ServiceRequest.category:il-core | required | Pattern: SNOMED-CT Code 108252007("Laboratory procedure")http://fhir.health.gov.il/ValueSet/il-core-service-category | ||||
ServiceRequest.code | extensible | LrcReferralCodes
http://ig.fhir-il-community.org/LRC/ValueSet/lrc-referral-codes from this IG | ||||
ServiceRequest.reasonCode | extensible | ILCoreProcedureReasonhttp://fhir.health.gov.il/ValueSet/il-core-procedure-reason |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | ServiceRequest | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | ServiceRequest | 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 | ServiceRequest | 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 | ServiceRequest | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | ServiceRequest | 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() | |
prr-1 | error | ServiceRequest | orderDetail SHALL only be present if code is present : orderDetail.empty() or code.exists() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
ServiceRequest | C | 0..* | ILCoreServiceRequest | ILCore ServiceRequest Profile prr-1: orderDetail SHALL only be present if code is present | ||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 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 | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | Σ | 1..* | Identifier | Identifiers assigned to this order | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
system | Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
value | Σ | 1..1 | string | The value that is unique Example General: 123456 | ||||
period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
instantiatesCanonical | Σ | 0..* | canonical(ActivityDefinition | PlanDefinition) | Instantiates FHIR protocol or definition | ||||
instantiatesUri | Σ | 0..* | uri | Instantiates external protocol or definition | ||||
basedOn | Σ | 0..* | Reference(CarePlan | ILCore ServiceRequest Profile | ILCore MedicationRequest Profile) | What request fulfills | ||||
replaces | Σ | 0..* | Reference(ILCore ServiceRequest Profile) | What request replaces | ||||
requisition | Σ | 0..1 | Identifier | Composite Request ID | ||||
status | ?!SΣ | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): The status of a service order. | ||||
intent | ?!SΣ | 1..1 | code | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option Binding: RequestIntent (required): The kind of service request. Fixed Value: order | ||||
Slices for category | SΣ | 1..* | CodeableConcept | Classification of service Slice: Unordered, Open by pattern:$this Binding: IL Core ServiceCategory (extensible) | ||||
category:il-core | Σ | 0..* | CodeableConcept | Classification of service Binding: IL Core ServiceCategory (required) Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 108252007 | |||||
display | 1..1 | string | Representation defined by the system Fixed Value: Laboratory procedure | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 1..1 | uri | Identity of the terminology system Required Pattern: http://snomed.info/sct | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 1..1 | code | Symbol in syntax defined by the system | ||||
display | Σ | 1..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
priority | Σ | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request. | ||||
doNotPerform | ?!Σ | 0..1 | boolean | True if service/procedure should not be performed | ||||
code | SΣ | 1..1 | CodeableConcept | What is being requested/ordered Binding: Lrc Referral Codes (extensible)
| ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 1..1 | uri | Identity of the terminology system | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 1..1 | code | Symbol in syntax defined by the system | ||||
display | Σ | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
orderDetail | ΣC | 0..* | CodeableConcept | Additional order information Binding: ServiceRequestOrderDetailsCodes (example): Codified order entry details which are based on order context. | ||||
quantity[x] | Σ | 0..1 | Service amount | |||||
quantityQuantity | Quantity | |||||||
quantityRatio | Ratio | |||||||
quantityRange | Range | |||||||
subject | SΣ | 1..1 | Reference(ILCore Patient Profile) | Individual or Entity the service is ordered for | ||||
encounter | Σ | 0..1 | Reference(ILCore Encounter Profile) | Encounter in which the request was created | ||||
Slices for occurrence[x] | SΣ | 0..1 | When service should occur Slice: Unordered, Open by type:$this | |||||
occurrenceDateTime | dateTime | |||||||
occurrencePeriod | Period | |||||||
occurrenceTiming | Timing | |||||||
occurrence[x]:occurrenceDateTime | SΣ | 0..1 | dateTime | When service should occur | ||||
id | 0..1 | string | xml:id (or equivalent in JSON) | |||||
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
relative-date | 0..1 | (Complex) | Extension: Relative Date Criteria URL: http://hl7.org/fhir/StructureDefinition/relative-date | |||||
value | 0..1 | dateTime | Primitive value for dateTime | |||||
occurrence[x]:occurrencePeriod | SΣ | 0..1 | Period | When service should occur | ||||
asNeeded[x] | Σ | 0..1 | Preconditions for service Binding: SNOMEDCTMedicationAsNeededReasonCodes (example): A coded concept identifying the pre-condition that should hold prior to performing a procedure. For example "pain", "on flare-up", etc. | |||||
asNeededBoolean | boolean | |||||||
asNeededCodeableConcept | CodeableConcept | |||||||
authoredOn | SΣ | 0..1 | dateTime | Date request signed | ||||
requester | SΣ | 1..1 | Reference(ILCore Practitioner Profile | ILCore PractitionerRole Profile | ILCore Organization Profile | ILCore Patient Profile | ILCore RelatedPerson Profile | ILCore Device Profile) | Who/what is requesting service | ||||
performerType | Σ | 0..1 | CodeableConcept | Performer role Binding: ParticipantRoles (example): Indicates specific responsibility of an individual within the care team, such as "Primary physician", "Team coordinator", "Caregiver", etc. | ||||
performer | Σ | 0..* | Reference(ILCore Practitioner Profile | ILCore PractitionerRole Profile | ILCore Organization Profile | CareTeam | HealthcareService | ILCore Patient Profile | ILCore Device Profile | ILCore RelatedPerson Profile) | Requested performer | ||||
locationCode | Σ | 0..* | CodeableConcept | Requested location Binding: ServiceDeliveryLocationRoleType (example): A location type where services are delivered. | ||||
locationReference | Σ | 0..* | Reference(ILCore Location Profile) | Requested location | ||||
reasonCode | SΣ | 0..* | CodeableConcept | Explanation/Justification for procedure or service Binding: IL Core procedure Reason (extensible) | ||||
reasonReference | Σ | 0..* | Reference(ILCore Condition Profile | ILCore Observation Profile | ILCore DiagnosticReport Profile | DocumentReference) | Explanation/Justification for service or service | ||||
insurance | 0..* | Reference(Coverage | ClaimResponse) | Associated insurance coverage | |||||
supportingInfo | 0..* | Reference(Resource) | Additional clinical information | |||||
specimen | Σ | 0..* | Reference(ILCore Specimen Profile) | Procedure Samples | ||||
bodySite | Σ | 0..* | CodeableConcept | Location on Body Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. | ||||
note | 0..* | Annotation | Comments | |||||
patientInstruction | Σ | 0..1 | string | Patient or consumer-oriented instructions | ||||
relevantHistory | 0..* | Reference(Provenance) | Request provenance | |||||
Documentation for this format |
Path | Conformance | ValueSet / Code | URI | |||
ServiceRequest.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
ServiceRequest.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
ServiceRequest.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
ServiceRequest.status | required | RequestStatushttp://hl7.org/fhir/ValueSet/request-status|4.0.1 from the FHIR Standard | ||||
ServiceRequest.intent | required | Fixed Value: orderhttp://hl7.org/fhir/ValueSet/request-intent|4.0.1 from the FHIR Standard | ||||
ServiceRequest.category | extensible | ILCoreServiceCategoryhttp://fhir.health.gov.il/ValueSet/il-core-service-category | ||||
ServiceRequest.category:il-core | required | Pattern: SNOMED-CT Code 108252007("Laboratory procedure")http://fhir.health.gov.il/ValueSet/il-core-service-category | ||||
ServiceRequest.priority | required | RequestPriorityhttp://hl7.org/fhir/ValueSet/request-priority|4.0.1 from the FHIR Standard | ||||
ServiceRequest.code | extensible | LrcReferralCodes
http://ig.fhir-il-community.org/LRC/ValueSet/lrc-referral-codes from this IG | ||||
ServiceRequest.orderDetail | example | ServiceRequestOrderDetailsCodeshttp://hl7.org/fhir/ValueSet/servicerequest-orderdetail from the FHIR Standard | ||||
ServiceRequest.asNeeded[x] | example | SNOMEDCTMedicationAsNeededReasonCodeshttp://hl7.org/fhir/ValueSet/medication-as-needed-reason from the FHIR Standard | ||||
ServiceRequest.performerType | example | ParticipantRoleshttp://hl7.org/fhir/ValueSet/participant-role from the FHIR Standard | ||||
ServiceRequest.locationCode | example | ServiceDeliveryLocationRoleTypehttp://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType | ||||
ServiceRequest.reasonCode | extensible | ILCoreProcedureReasonhttp://fhir.health.gov.il/ValueSet/il-core-procedure-reason | ||||
ServiceRequest.bodySite | example | SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-site from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | ServiceRequest | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | ServiceRequest | 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 | ServiceRequest | 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 | ServiceRequest | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | ServiceRequest | 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() | |
prr-1 | error | ServiceRequest | orderDetail SHALL only be present if code is present : orderDetail.empty() or code.exists() |
This structure is derived from ILCoreServiceRequest
Other representations of profile: CSV, Excel, Schematron