. Page versions: R5 R4B R4 R3 R2This page is part of the FHIR Specification (v0.0.82: DSTU 1). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3 R2
Profile for list
{
"resourceType": "Profile",
"text": {
"status": "generated",
"div": "<div><pre>\r\n<<a title=\"A set of information summarized from a list of other resources.\" class=\"dict\" href=\"list-definitions.html#List\"><b>List</b></a> xmlns="http://hl7.org/fhir"> <span style=\"float: right\"><a title=\"Documentation for this format\" href=\"formats.html\"><img alt=\"doco\" src=\"help.png\"/></a></span>\r\n <!-- from <a href=\"resources.html\">Resource</a>: <a href=\"extensibility.html\">extension</a>, <a href=\"extensibility.html#modifierExtension\">modifierExtension</a>, language, <a href=\"narrative.html#Narrative\">text</a>, and <a href=\"references.html#contained\">contained</a> -->\r\n <<a title=\"Identifier for the List assigned for business purposes outside the context of FHIR.\" class=\"dict\" href=\"list-definitions.html#List.identifier\"><b>identifier</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#Identifier\">Identifier</a></span> <span style=\"color: navy\">Business identifier</span><span style=\"color: Gray\"> --></span></identifier>\r\n <<a title=\"This code defines the purpose of the list - why it was created.\" class=\"dict\" href=\"list-definitions.html#List.code\"><b>code</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-list-example-codes.html\">What the purpose of this list is</a></span><span style=\"color: Gray\"> --></span></code>\r\n <<a title=\"The common subject (or patient) of the resources that are in the list, if there is one.\" class=\"dict\" href=\"list-definitions.html#List.subject\"><b>subject</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"patient.html#Patient\">Patient</a>|<a href=\"group.html#Group\">Group</a>|<a href=\"device.html#Device\">Device</a>|<a href=\"location.html#Location\">Location</a>)</span> <span style=\"color: navy\">\r\n If all resources have the same subject</span><span style=\"color: Gray\"> --></span></subject>\r\n <<a title=\"The entity responsible for deciding what the contents of the list were.\" class=\"dict\" href=\"list-definitions.html#List.source\"><b>source</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"practitioner.html#Practitioner\">Practitioner</a>|<a href=\"patient.html#Patient\">Patient</a>|<a href=\"device.html#Device\">Device</a>)</span> <span style=\"color: navy\">\r\n Who and/or what defined the list contents</span><span style=\"color: Gray\"> --></span></source>\r\n <<a title=\"The date that the list was prepared.\" class=\"dict\" href=\"list-definitions.html#List.date\"><b>date</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#dateTime\">dateTime</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">When the list was prepared</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Whether items in the list have a meaningful order (this element modifies the meaning of other elements)\" class=\"dict\" href=\"list-definitions.html#List.ordered\"><span style=\"text-decoration: underline\"><b>ordered</b></span></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#boolean\">boolean</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">Whether items in the list have a meaningful order</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"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 (this element modifies the meaning of other elements)\" class=\"dict\" href=\"list-definitions.html#List.mode\"><span style=\"text-decoration: underline\"><b>mode</b></span></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#code\">code</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"list-mode.html\">working | snapshot | changes</a></span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"Entries in this list.\" class=\"dict\" href=\"list-definitions.html#List.entry\"><b>entry</b></a>> <span style=\"color: Gray\"><!-- <span title=\"Inv-1: A list can only have an emptyReason if it is empty\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..*</b></span> Entries in the list --></span>\r\n <<a title=\"The flag allows the system constructing the list to make one or more statements about the role and significance of the item in the list.\" class=\"dict\" href=\"list-definitions.html#List.entry.flag\"><b>flag</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..*</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-list-item-flag.html\">Workflow information about this item</a></span><span style=\"color: Gray\"> --></span></flag>\r\n <<a title=\"True if this item is marked as deleted in the list (this element modifies the meaning of other elements)\" class=\"dict\" href=\"list-definitions.html#List.entry.deleted\"><span style=\"text-decoration: underline\"><b>deleted</b></span></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#boolean\">boolean</a></span>]"/><span style=\"color: Gray\"><!--</span> <span title=\"Inv-2: The deleted flag can only be used if the mode of the list is "changes"\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..1</b></span> <span style=\"color: navy\">If this item is actually marked as deleted</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"When this item was added to the list.\" class=\"dict\" href=\"list-definitions.html#List.entry.date\"><b>date</b></a> value="[<span style=\"color: darkgreen\"><a href=\"datatypes.html#dateTime\">dateTime</a></span>]"/><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>0..1</b></span> <span style=\"color: navy\">When item added to list</span><span style=\"color: Gray\"> --></span>\r\n <<a title=\"A reference to the actual resource from which data was derived.\" class=\"dict\" href=\"list-definitions.html#List.entry.item\"><b>item</b></a>><span style=\"color: Gray\"><!--</span> <span style=\"color: brown\"><b>1..1</b></span> <span style=\"color: darkgreen\"><a href=\"references.html#Resource\">Resource</a>(<a href=\"resourcelist.html\">Any</a>)</span> <span style=\"color: navy\">Actual entry</span><span style=\"color: Gray\"> --></span></item>\r\n </entry>\r\n <<a title=\"If the list is empty, why the list is empty.\" class=\"dict\" href=\"list-definitions.html#List.emptyReason\"><b>emptyReason</b></a>><span style=\"color: Gray\"><!--</span> <span title=\"Inv-1: A list can only have an emptyReason if it is empty\" style=\"color: brown\"><b><img alt=\"??\" src=\"lock.png\"/> 0..1</b></span> <span style=\"color: darkgreen\"><a href=\"datatypes.html#CodeableConcept\">CodeableConcept</a></span> <span style=\"color: navy\"><a style=\"color: navy\" href=\"valueset-list-empty-reason.html\">Why list is empty</a></span><span style=\"color: Gray\"> --></span></emptyReason>\r\n</List>\r\n</pre></div>"
},
"name": "list",
"publisher": "FHIR Project",
"description": "Basic Profile. A set of information summarized from a list of other resources.",
"status": "draft",
"date": "2014-09-30",
"requirements": "Scope and Usage List resources are used in many places, including allergies, medications, alerts, medical history, etc.",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM"
}
],
"structure": [
{
"type": "List",
"publish": true,
"element": [
{
"path": "List",
"definition": {
"short": "Information summarized from a list of other resources",
"formal": "A set of information summarized from a list of other resources.",
"min": 1,
"max": "1",
"type": [
{
"code": "Resource"
}
],
"constraint": [
{
"key": "2",
"name": "Deleted Rule",
"severity": "error",
"human": "The deleted flag can only be used if the mode of the list is \"changes\"",
"xpath": "(f:mode/@value = 'changes') or not(exists(f:entry/f:item/f:deleted))"
},
{
"key": "1",
"name": "No emptyReason if list is not empty",
"severity": "error",
"human": "A list can only have an emptyReason if it is empty",
"xpath": "not(exists(f:emptyReason) and exists(f:entry))"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "Act[classCode<ORG,moodCode=EVN]"
}
]
}
},
{
"path": "List.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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.",
"comments": "there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "List.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "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. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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.",
"comments": "there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "List.text",
"definition": {
"short": "Text summary of the resource, for human interpretation",
"formal": "A human-readable narrative that contains a summary of the resource, and may 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.",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
"synonym": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Narrative"
}
],
"isModifier": false
}
},
{
"path": "List.contained",
"definition": {
"short": "Contained, inline Resources",
"formal": "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.",
"comments": "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.",
"synonym": [
"inline resources",
"anonymous resources",
"contained resources"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Resource"
}
],
"isModifier": false
}
},
{
"path": "List.identifier",
"definition": {
"short": "Business identifier",
"formal": "Identifier for the List assigned for business purposes outside the context of FHIR.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".id"
}
]
}
},
{
"path": "List.code",
"definition": {
"short": "What the purpose of this list is",
"formal": "This code defines the purpose of the list - why it was created.",
"comments": "If there is no code, the purpose of the list is implied where it is used, such as in a document section using Document.section.code.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "ListPurpose",
"isExtensible": true,
"conformance": "example",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/list-example-codes"
}
},
"mapping": [
{
"identity": "rim",
"map": ".code"
}
]
}
},
{
"path": "List.subject",
"definition": {
"short": "If all resources have the same subject",
"formal": "The common subject (or patient) of the resources that are in the list, if there is one.",
"comments": "Some purely aribitrary lists do not have a common subject, so this is optional.",
"min": 0,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Patient"
},
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Group"
},
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Device"
},
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Location"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode<SUB].role\n(and sometimes .player)"
}
]
}
},
{
"path": "List.source",
"definition": {
"short": "Who and/or what defined the list contents",
"formal": "The entity responsible for deciding what the contents of the list were.",
"comments": "The primary source is the entity that made the decisions what items are in the list. This may be software or user.",
"min": 0,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Practitioner"
},
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Patient"
},
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Device"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode<AUT].role[classCode=REL].player[classCode=PSN,determinerCode=INST]\nor\n.participation[typeCode<AUT].role[classCode=REL].player[classCode=DEV,determinerCode=INST]"
}
]
}
},
{
"path": "List.date",
"definition": {
"short": "When the list was prepared",
"formal": "The date that the list was prepared.",
"comments": "The actual important date is the date of currency of the resources that were summarized, but it is usually assumed that these are current when the preparation occurs.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".participation[typeCode<AUT].time[type=TS]"
}
]
}
},
{
"path": "List.ordered",
"definition": {
"short": "Whether items in the list have a meaningful order",
"formal": "Whether items in the list have a meaningful order.",
"comments": "Applications SHOULD render ordered lists in the order provided, but MAY allow users to re-order based on their own preferences as well. This is marked as \"is modifier\" because whether the list is ordered or not may change how the results are processed or displayed.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"isModifier": true,
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=COMP].sequenceNumber > 1"
}
]
}
},
{
"path": "List.mode",
"definition": {
"short": "working | snapshot | changes",
"formal": "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.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"binding": {
"name": "ListMode",
"isExtensible": false,
"conformance": "required",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/list-mode"
}
},
"mapping": [
{
"identity": "rim",
"map": ".outBoundRelationship[typeCode=COMP].target[classCode=OBS\"].value"
}
]
}
},
{
"path": "List.entry",
"definition": {
"short": "Entries in the list",
"formal": "Entries in this list.",
"comments": "If there are no entries in the list, an emptyReason SHOULD be provided.",
"min": 0,
"max": "*",
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=COMP]\nor \n.participation[typeCode=SBJ]"
}
]
}
},
{
"path": "List.entry.extension",
"definition": {
"short": "Additional Content defined by implementations",
"formal": "May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict 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.",
"comments": "there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "List.entry.modifierExtension",
"definition": {
"short": "Extensions that cannot be ignored",
"formal": "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. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict 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.",
"comments": "there can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core simplicity for everyone.",
"synonym": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"isModifier": false
}
},
{
"path": "List.entry.flag",
"definition": {
"short": "Workflow information about this item",
"formal": "The flag allows the system constructing the list to make one or more statements about the role and significance of the item in the list.",
"comments": "The flag can only be understood in the context of the List.code. If the flag means that the entry has actually been deleted from the list, the deleted element SHALL be true. Deleted can only be used if the List.mode is \"changes\".",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "ListItemFlag",
"isExtensible": true,
"conformance": "example",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/list-item-flag"
}
},
"mapping": [
{
"identity": "rim",
"map": ".outBoundRelationship[typeCode=COMP].target[classCode=OBS\"].value"
}
]
}
},
{
"path": "List.entry.deleted",
"definition": {
"short": "If this item is actually marked as deleted",
"formal": "True if this item is marked as deleted in the list.",
"comments": "If the flag means that the entry has actually been deleted from the list, the deleted element SHALL be true. Both flag and deleted can only be used if the List.mode is \"changes\". A deleted entry should be displayed in narrative as deleted.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"isModifier": true,
"mapping": [
{
"identity": "rim",
"map": "added: .updateMode=(\"A\",\"AR\")\n\nretained: .updateMode=\"NC\"\n\nupdated: .updateMode=\"R\"\n\ndeleted: .updateMode=\"D\""
}
]
}
},
{
"path": "List.entry.date",
"definition": {
"short": "When item added to list",
"formal": "When this item was added to the list.",
"comments": "This is only useful and meaningful when the mode is \"working\".",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".availabilityTime"
}
]
}
},
{
"path": "List.entry.item",
"definition": {
"short": "Actual entry",
"formal": "A reference to the actual resource from which data was derived.",
"min": 1,
"max": "1",
"type": [
{
"code": "ResourceReference",
"profile": "http://hl7.org/fhir/profiles/Any"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": ".target\nor\n.role\nor\n.role.entity"
}
]
}
},
{
"path": "List.emptyReason",
"definition": {
"short": "Why list is empty",
"formal": "If the list is empty, why the list is empty.",
"comments": "The various reasons for an empty list make a significant interpretation to its interpretation.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isModifier": false,
"binding": {
"name": "ListEmptyReason",
"isExtensible": true,
"conformance": "preferred",
"referenceResource": {
"reference": "http://hl7.org/fhir/vs/list-empty-reason"
}
},
"mapping": [
{
"identity": "rim",
"map": ".inboundRelationship[typeCode=SUBJ,code<{ListEmptyReason}].value[type=CD]"
}
]
}
}
],
"searchParam": [
{
"name": "_id",
"type": "token",
"documentation": "The logical resource id associated with the resource (must be supported by all servers)"
},
{
"name": "_language",
"type": "token",
"documentation": "The language of the resource"
},
{
"name": "code",
"type": "token",
"documentation": "What the purpose of this list is",
"xpath": "f:List/f:code"
},
{
"name": "date",
"type": "date",
"documentation": "When the list was prepared",
"xpath": "f:List/f:date"
},
{
"name": "empty-reason",
"type": "token",
"documentation": "Why list is empty",
"xpath": "f:List/f:emptyReason"
},
{
"name": "item",
"type": "reference",
"documentation": "Actual entry",
"xpath": "f:List/f:entry/f:item"
},
{
"name": "source",
"type": "reference",
"documentation": "Who and/or what defined the list contents",
"xpath": "f:List/f:source"
},
{
"name": "subject",
"type": "reference",
"documentation": "If all resources have the same subject",
"xpath": "f:List/f:subject"
}
]
}
]
}
© HL7.org 2011+. FHIR DSTU (v0.0.82.2943) generated on Tue, Sep 30, 2014 18:09+1000.
Links:
What's a DSTU? |
Version History |
|
Propose a change