List
| Property | Value |
|---|---|
| Publisher | |
| Name | List |
| URL | http://hl7.org/fhir/StructureDefinition/List |
| Status | draft |
| Description | |
| Abstract | false |
Structure
| Path | Cardinality | Type | Description |
|---|---|---|---|
| List | 0..* | List | A list is a curated collection of resources. |
| List.id | 0..1 | http://hl7.org/fhirpath/System.String | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
| List.meta | 0..1 | Meta | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
| List.implicitRules | 0..1 | uri | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
| List.language | 0..1 | code | The base language in which the resource is written. |
| List.text | 0..1 | Narrative | A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
| List.contained | 0..* | Resource | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
| List.extension | 0..* | Extension | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| List.modifierExtension | 0..* | Extension | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
| List.identifier | 0..* | Identifier | Identifier for the List assigned for business purposes outside the context of FHIR. |
| List.status | 1..1 | code | Indicates the current state of this list. |
| List.mode | 1..1 | code | How this list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted. |
| List.title | 0..1 | string | A label for the list assigned by the author. |
| List.code | 0..1 | CodeableConcept | This code defines the purpose of the list - why it was created. |
| List.subject | 0..1 | Reference | The common subject (or patient) of the resources that are in the list if there is one. |
| List.encounter | 0..1 | Reference | The encounter that is the context in which this list was created. |
| List.date | 0..1 | dateTime | The date that the list was prepared. |
| List.source | 0..1 | Reference | The entity responsible for deciding what the contents of the list were. Where the list was created by a human, this is the same as the author of the list. |
| List.orderedBy | 0..1 | CodeableConcept | What order applies to the items in the list. |
| List.note | 0..* | Annotation | Comments that apply to the overall list. |
| List.entry | 0..* | BackboneElement | Entries in this list. |
| List.entry.id | 0..1 | http://hl7.org/fhirpath/System.String | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| List.entry.extension | 0..* | Extension | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| List.entry.modifierExtension | 0..* | Extension | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
| List.entry.flag | 0..1 | CodeableConcept | The flag allows the system constructing the list to indicate the role and significance of the item in the list. |
| List.entry.deleted | 0..1 | boolean | True if this item is marked as deleted in the list. |
| List.entry.date | 0..1 | dateTime | When this item was added to the list. |
| List.entry.item | 1..1 | Reference | A reference to the actual resource from which data was derived. |
| List.emptyReason | 0..1 | CodeableConcept | If the list is empty, why the list is empty. |
Search Parameters
| Name | Type | Description | Expression |
|---|---|---|---|
| _text | string | Search on the narrative of the resource | |
| _content | string | Search on the entire content of the resource | |
| _id | token | Logical id of this artifact | Resource.id |
| _lastUpdated | date | When the resource version last changed | Resource.meta.lastUpdated |
| _profile | uri | Profiles this resource claims to conform to | Resource.meta.profile |
| _query | token | A custom search profile that describes a specific defined query operation | |
| _security | token | Security Labels applied to this resource | Resource.meta.security |
| _source | uri | Identifies where the resource comes from | Resource.meta.source |
| _tag | token | Tags applied to this resource | Resource.meta.tag |
| code | token | Multiple Resources: * AllergyIntolerance: Code that identifies the allergy or intolerance* Condition: Code for the condition* DeviceRequest: Code for what is being requested/ordered* DiagnosticReport: The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result* FamilyMemberHistory: A search by a condition code* List: What the purpose of this list is* Medication: Returns medications for a specific code* MedicationAdministration: Return administrations of this medication code* MedicationDispense: Returns dispenses of this medicine code* MedicationRequest: Return prescriptions of this medication code* MedicationStatement: Return statements of this medication code* Observation: The code of the observation type* Procedure: A code to identify a procedure* ServiceRequest: What is being requested/ordered | AllergyIntolerance.code / AllergyIntolerance.reaction.substance / Condition.code / (DeviceRequest.code.ofType(CodeableConcept)) / DiagnosticReport.code / FamilyMemberHistory.condition.code / List.code / Medication.code / (MedicationAdministration.medication.ofType(CodeableConcept)) / (MedicationDispense.medication.ofType(CodeableConcept)) / (MedicationRequest.medication.ofType(CodeableConcept)) / (MedicationStatement.medication.ofType(CodeableConcept)) / Observation.code / Procedure.code / ServiceRequest.code |
| date | date | Multiple Resources: * AllergyIntolerance: Date first version of the resource instance was recorded* CarePlan: Time period plan covers* CareTeam: Time period team covers* ClinicalImpression: When the assessment was documented* Composition: Composition editing time* Consent: When this Consent was created or indexed* DiagnosticReport: The clinically relevant time of the report* Encounter: A date within the period the Encounter lasted* EpisodeOfCare: The provided date search value falls within the episode of care's period* FamilyMemberHistory: When history was recorded or last updated* Flag: Time period when flag is active* Immunization: Vaccination (non)-Administration Date* List: When the list was prepared* Observation: Obtained date/time. If the obtained element is a period, a date that falls in the period* Procedure: When the procedure was performed* RiskAssessment: When was assessment made?* SupplyRequest: When the request was made | AllergyIntolerance.recordedDate / CarePlan.period / CareTeam.period / ClinicalImpression.date / Composition.date / Consent.dateTime / DiagnosticReport.effective / Encounter.period / EpisodeOfCare.period / FamilyMemberHistory.date / Flag.period / Immunization.occurrence / List.date / Observation.effective / Procedure.performed / (RiskAssessment.occurrence.ofType(dateTime)) / SupplyRequest.authoredOn |
| identifier | token | Multiple Resources: * AllergyIntolerance: External ids for this item* CarePlan: External Ids for this plan* CareTeam: External Ids for this team* Composition: Version-independent identifier for the Composition* Condition: A unique identifier of the condition record* Consent: Identifier for this record (external references)* DetectedIssue: Unique id for the detected issue* DeviceRequest: Business identifier for request/order* DiagnosticReport: An identifier for the report* DocumentManifest: Unique Identifier for the set of documents* DocumentReference: Master Version Specific Identifier* Encounter: Identifier(s) by which this encounter is known* EpisodeOfCare: Business Identifier(s) relevant for this EpisodeOfCare* FamilyMemberHistory: A search by a record identifier* Goal: External Ids for this goal* ImagingStudy: Identifiers for the Study, such as DICOM Study Instance UID and Accession number* Immunization: Business identifier* List: Business identifier* MedicationAdministration: Return administrations with this external identifier* MedicationDispense: Returns dispenses with this external identifier* MedicationRequest: Return prescriptions with this external identifier* MedicationStatement: Return statements with this external identifier* NutritionOrder: Return nutrition orders with this external identifier* Observation: The unique id for a particular observation* Procedure: A unique identifier for a procedure* RiskAssessment: Unique identifier for the assessment* ServiceRequest: Identifiers assigned to this order* SupplyDelivery: External identifier* SupplyRequest: Business Identifier for SupplyRequest* VisionPrescription: Return prescriptions with this external identifier | AllergyIntolerance.identifier / CarePlan.identifier / CareTeam.identifier / Composition.identifier / Condition.identifier / Consent.identifier / DetectedIssue.identifier / DeviceRequest.identifier / DiagnosticReport.identifier / DocumentManifest.masterIdentifier / DocumentManifest.identifier / DocumentReference.masterIdentifier / DocumentReference.identifier / Encounter.identifier / EpisodeOfCare.identifier / FamilyMemberHistory.identifier / Goal.identifier / ImagingStudy.identifier / Immunization.identifier / List.identifier / MedicationAdministration.identifier / MedicationDispense.identifier / MedicationRequest.identifier / MedicationStatement.identifier / NutritionOrder.identifier / Observation.identifier / Procedure.identifier / RiskAssessment.identifier / ServiceRequest.identifier / SupplyDelivery.identifier / SupplyRequest.identifier / VisionPrescription.identifier |
| patient | reference | Multiple Resources: * AllergyIntolerance: Who the sensitivity is for* CarePlan: Who the care plan is for* CareTeam: Who care team is for* ClinicalImpression: Patient or group assessed* Composition: Who and/or what the composition is about* Condition: Who has the condition?* Consent: Who the consent applies to* DetectedIssue: Associated patient* DeviceRequest: Individual the service is ordered for* DeviceUseStatement: Search by subject - a patient* DiagnosticReport: The subject of the report if a patient* DocumentManifest: The subject of the set of documents* DocumentReference: Who/what is the subject of the document* Encounter: The patient or group present at the encounter* EpisodeOfCare: The patient who is the focus of this episode of care* FamilyMemberHistory: The identity of a subject to list family member history items for* Flag: The identity of a subject to list flags for* Goal: Who this goal is intended for* ImagingStudy: Who the study is about* Immunization: The patient for the vaccination record* List: If all resources have the same subject* MedicationAdministration: The identity of a patient to list administrations for* MedicationDispense: The identity of a patient to list dispenses for* MedicationRequest: Returns prescriptions for a specific patient* MedicationStatement: Returns statements for a specific patient.* NutritionOrder: The identity of the person who requires the diet, formula or nutritional supplement* Observation: The subject that the observation is about (if patient)* Procedure: Search by subject - a patient* RiskAssessment: Who/what does assessment apply to?* ServiceRequest: Search by subject - a patient* SupplyDelivery: Patient for whom the item is supplied* VisionPrescription: The identity of a patient to list dispenses for | AllergyIntolerance.patient / CarePlan.subject.where(resolve() is Patient) / CareTeam.subject.where(resolve() is Patient) / ClinicalImpression.subject.where(resolve() is Patient) / Composition.subject.where(resolve() is Patient) / Condition.subject.where(resolve() is Patient) / Consent.patient / DetectedIssue.patient / DeviceRequest.subject.where(resolve() is Patient) / DeviceUseStatement.subject / DiagnosticReport.subject.where(resolve() is Patient) / DocumentManifest.subject.where(resolve() is Patient) / DocumentReference.subject.where(resolve() is Patient) / Encounter.subject.where(resolve() is Patient) / EpisodeOfCare.patient / FamilyMemberHistory.patient / Flag.subject.where(resolve() is Patient) / Goal.subject.where(resolve() is Patient) / ImagingStudy.subject.where(resolve() is Patient) / Immunization.patient / List.subject.where(resolve() is Patient) / MedicationAdministration.subject.where(resolve() is Patient) / MedicationDispense.subject.where(resolve() is Patient) / MedicationRequest.subject.where(resolve() is Patient) / MedicationStatement.subject.where(resolve() is Patient) / NutritionOrder.patient / Observation.subject.where(resolve() is Patient) / Procedure.subject.where(resolve() is Patient) / RiskAssessment.subject.where(resolve() is Patient) / ServiceRequest.subject.where(resolve() is Patient) / SupplyDelivery.patient / VisionPrescription.patient |
| encounter | reference | Multiple Resources: * Composition: Context of the Composition* DeviceRequest: Encounter during which request was created* DiagnosticReport: The Encounter when the order was made* DocumentReference: Context of the document content* Flag: Alert relevant during encounter* List: Context in which list created* NutritionOrder: Return nutrition orders with this encounter identifier* Observation: Encounter related to the observation* Procedure: Encounter created as part of* RiskAssessment: Where was assessment performed?* ServiceRequest: An encounter in which this request is made* VisionPrescription: Return prescriptions with this encounter identifier | Composition.encounter / DeviceRequest.encounter / DiagnosticReport.encounter / DocumentReference.context.encounter / Flag.encounter / List.encounter / NutritionOrder.encounter / Observation.encounter / Procedure.encounter / RiskAssessment.encounter / ServiceRequest.encounter / VisionPrescription.encounter |
| empty-reason | token | Why list is empty | List.emptyReason |
| item | reference | Actual entry | List.entry.item |
| notes | string | The annotation - text content (as markdown) | List.note.text |
| source | reference | Who and/or what defined the list contents (aka Author) | List.source |
| status | token | current / retired / entered-in-error | List.status |
| subject | reference | If all resources have the same subject | List.subject |
| title | string | Descriptive name for the list | List.title |
| _iguhealth-version-seq | number | The version sequence of the resource | Resource.meta.extension.where(url='https://iguhealth.app/version-sequence').value |
| _iguhealth-author | reference | The author of the resource | Resource.meta.extension.where(url='https://iguhealth.app/author').value |