StructureDefinition: DAFImmunizationList

StructureDefinition for US Realm Immunization list

{
  "resourceType": "StructureDefinition",
  "id": "list-daf-dafimmunizationlist",
  "text": {
    "status": "generated",
    "div": "<div>!-- Snipped for Brevity --></div>"
  },
  "url": "http://hl7.org/fhir/StructureDefinition/list-daf-dafimmunizationlist",
  "name": "U.S. Data Access Framework (DAF) List Profile",
  "publisher": "U.S. Office of the National Coordinator (ONC)",
  "contact": [
    {
      "telecom": [
        {
          "system": "url",
          "value": "http://www.healthit.gov"
        }
      ]
    }
  ],
  "description": "US Realm Immunization list",
  "status": "draft",
  "date": "2014-08-21",
  "type": "constraint",
  "abstract": false,
  "base": "http://hl7.org/fhir/StructureDefinition/List",
  "snapshot": {
    "element": [
      {
        "path": "List",
        "name": "DAFImmunizationList",
        "short": "US Realm Immunization list",
        "definition": "Information summarized from a list of other resources.",
        "alias": [
          "Collection",
          "WorkingList",
          "Organizer"
        ],
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "List"
          }
        ],
        "constraint": [
          {
            "key": "lst-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": "lst-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))"
          }
        ],
        "mapping": [
          {
            "identity": "rim",
            "map": "Act[classCode<ORG,moodCode=EVN]"
          }
        ]
      },
      {
        "path": "List.id",
        "short": "Logical id of this artefact",
        "definition": "The logical id of the resource, as used in the url for the resoure. Once assigned, this value never changes.",
        "comments": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Bundles always have an id, though it is usually a generated UUID.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "id"
          }
        ]
      },
      {
        "path": "List.meta",
        "short": "Metadata about the resource",
        "definition": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "Meta"
          }
        ]
      },
      {
        "path": "List.implicitRules",
        "short": "A set of rules under which this content was created",
        "definition": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.",
        "comments": "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element as much as possible.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "uri"
          }
        ],
        "isModifier": true
      },
      {
        "path": "List.language",
        "short": "Language of the resource content",
        "definition": "The base language in which the resource is written.",
        "comments": "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies  to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource\n\nNot all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "code"
          }
        ],
        "binding": {
          "name": "Language",
          "strength": "required",
          "description": "A human language",
          "valueSetUri": "http://tools.ietf.org/html/bcp47"
        }
      },
      {
        "path": "List.text",
        "short": "Text summary of the resource, for human interpretation",
        "definition": "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.",
        "alias": [
          "narrative",
          "html",
          "xhtml",
          "display"
        ],
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "Narrative"
          }
        ],
        "condition": [
          "dom-1"
        ],
        "mapping": [
          {
            "identity": "rim",
            "map": "Act.text?"
          }
        ]
      },
      {
        "path": "List.contained",
        "short": "Contained, inline Resources",
        "definition": "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.",
        "alias": [
          "inline resources",
          "anonymous resources",
          "contained resources"
        ],
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "Resource"
          }
        ],
        "mapping": [
          {
            "identity": "rim",
            "map": "N/A"
          }
        ]
      },
      {
        "path": "List.extension",
        "short": "Additional Content defined by implementations",
        "definition": "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 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.",
        "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 level of simplicity for everyone.",
        "alias": [
          "extensions",
          "user content"
        ],
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "Extension"
          }
        ],
        "mapping": [
          {
            "identity": "rim",
            "map": "N/A"
          }
        ]
      },
      {
        "path": "List.modifierExtension",
        "short": "Extensions that cannot be ignored",
        "definition": "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 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.",
        "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 level of simplicity for everyone.",
        "alias": [
          "extensions",
          "user content"
        ],
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "Extension"
          }
        ],
        "isModifier": true,
        "mapping": [
          {
            "identity": "rim",
            "map": "N/A"
          }
        ]
      },
      {
        "path": "List.identifier",
        "short": "Business identifier",
        "definition": "Identifier for the List assigned for business purposes outside the context of FHIR.",
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "Identifier"
          }
        ],
        "mustSupport": true,
        "mapping": [
          {
            "identity": "rim",
            "map": ".id"
          }
        ]
      },
      {
        "path": "List.title",
        "short": "Descriptive name for the list",
        "definition": "A label for the list assigned by the author.",
        "requirements": "Allows customization beyond just the code identifying the kind of list.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "string"
          }
        ],
        "exampleString": "Dr. Jane's Patients",
        "isSummary": true
      },
      {
        "path": "List.code",
        "short": "Fixed code for Immunizations.",
        "definition": "Fixed code for Immunizations.",
        "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.",
        "requirements": "Lists often contain subsets of resources rather than an exhaustive list.  The code identifies what type of subset is included.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "CodeableConcept"
          }
        ],
        "fixedCodeableConcept": {
          "coding": [
            {
              "system": "http://loinc.org",
              "version": "2.48",
              "code": "11369-6"
            }
          ]
        },
        "mustSupport": true,
        "isSummary": true,
        "binding": {
          "name": "ListPurpose",
          "strength": "example",
          "description": "What the purpose of a list is",
          "valueSetReference": {
            "reference": "http://hl7.org/fhir/vs/list-example-codes"
          }
        },
        "mapping": [
          {
            "identity": "rim",
            "map": ".code"
          }
        ]
      },
      {
        "path": "List.subject",
        "short": "If all resources have the same subject",
        "definition": "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.",
        "requirements": "The primary purpose of listing the subject explicitly is to help with finding the right list.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "Reference",
            "profile": "http://hl7.org/fhir/StructureDefinition/patient-daf-dafpatient"
          }
        ],
        "mustSupport": true,
        "isSummary": true,
        "mapping": [
          {
            "identity": "rim",
            "map": ".participation[typeCode<SUB].role\n(and sometimes .player)"
          }
        ]
      },
      {
        "path": "List.source",
        "short": "Who and/or what defined the list contents",
        "definition": "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.",
        "requirements": "Allows follow-up as well as context.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "Reference",
            "profile": "http://hl7.org/fhir/StructureDefinition/pract-daf-dafpract"
          },
          {
            "code": "Reference",
            "profile": "http://hl7.org/fhir/StructureDefinition/patient-daf-dafpatient"
          },
          {
            "code": "Reference",
            "profile": "http://hl7.org/fhir/StructureDefinition/Device"
          }
        ],
        "mustSupport": true,
        "isSummary": true,
        "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.status",
        "short": "current | retired | entered-in-error",
        "definition": "Indicates the current state of this list.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "code"
          }
        ],
        "isModifier": true,
        "isSummary": true,
        "binding": {
          "name": "ListStatus",
          "strength": "required",
          "description": "The current state of the list",
          "valueSetReference": {
            "reference": "http://hl7.org/fhir/vs/list-status"
          }
        }
      },
      {
        "path": "List.date",
        "short": "When the list was prepared",
        "definition": "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.",
        "requirements": "Identifies how current the list is which affects relevance.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "dateTime"
          }
        ],
        "mustSupport": true,
        "isSummary": true,
        "mapping": [
          {
            "identity": "rim",
            "map": ".participation[typeCode<AUT].time[type=TS]"
          }
        ]
      },
      {
        "path": "List.orderedBy",
        "short": "What order the list has",
        "definition": "What order applies to the items in the list.",
        "comments": "Applications SHOULD render ordered lists in the order provided, but MAY allow users to re-order based on their own preferences as well. If there is no order specified, the order is unknown, though there may still be some order.",
        "requirements": "Important for presentation and rendering.  Lists may be sorted to place more important information first or to group related entries.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "CodeableConcept"
          }
        ],
        "binding": {
          "name": "ListOrder",
          "strength": "preferred",
          "description": "What order applies to the items in a list",
          "valueSetReference": {
            "reference": "http://hl7.org/fhir/vs/list-order"
          }
        },
        "mapping": [
          {
            "identity": "rim",
            "map": ".outboundRelationship[typeCode=COMP].sequenceNumber > 1"
          }
        ]
      },
      {
        "path": "List.mode",
        "short": "working | snapshot | changes",
        "definition": "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.",
        "requirements": "Lists are used in various ways, and it must be known in what way it is safe to use them.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "code"
          }
        ],
        "fixedCode": "snapshot",
        "mustSupport": true,
        "isModifier": true,
        "isSummary": true,
        "binding": {
          "name": "ListMode",
          "strength": "required",
          "description": "The processing mode that applies to this list",
          "valueSetReference": {
            "reference": "http://hl7.org/fhir/vs/list-mode"
          }
        },
        "mapping": [
          {
            "identity": "rim",
            "map": ".outBoundRelationship[typeCode=COMP].target[classCode=OBS\"].value"
          }
        ]
      },
      {
        "path": "List.note",
        "short": "Comments about the note",
        "definition": "Comments that apply to the overall list.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "string"
          }
        ]
      },
      {
        "path": "List.entry",
        "short": "Entries in the list",
        "definition": "Entries in this list.",
        "comments": "If there are no entries in the list, an emptyReason SHOULD be provided.",
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "Element"
          }
        ],
        "condition": [
          "lst-1"
        ],
        "mustSupport": true,
        "mapping": [
          {
            "identity": "rim",
            "map": ".outboundRelationship[typeCode=COMP]\nor \n.participation[typeCode=SBJ]"
          }
        ]
      },
      {
        "path": "List.entry.id",
        "representation": [
          "xmlAttr"
        ],
        "short": "xml:id (or equivalent in JSON)",
        "definition": "unique id for the element within a resource (for internal references).",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "id"
          }
        ],
        "mapping": [
          {
            "identity": "rim",
            "map": "n/a"
          }
        ]
      },
      {
        "path": "List.entry.extension",
        "short": "Additional Content defined by implementations",
        "definition": "May be used to represent additional information that is not part of the basic definition of the element. In order 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.",
        "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 level of simplicity for everyone.",
        "alias": [
          "extensions",
          "user content"
        ],
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "Extension"
          }
        ],
        "mapping": [
          {
            "identity": "rim",
            "map": "n/a"
          }
        ]
      },
      {
        "path": "List.entry.modifierExtension",
        "short": "Extensions that cannot be ignored",
        "definition": "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 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 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.",
        "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 level of simplicity for everyone.",
        "alias": [
          "extensions",
          "user content",
          "modifiers"
        ],
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "Extension"
          }
        ],
        "isModifier": true,
        "mapping": [
          {
            "identity": "rim",
            "map": "N/A"
          }
        ]
      },
      {
        "path": "List.entry.flag",
        "short": "Workflow information about this item",
        "definition": "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\".",
        "requirements": "This field is present to support various clinical uses of lists, such as a discharge summary medication list, where flags specify whether the medication was added, modified, or deleted from the list.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "CodeableConcept"
          }
        ],
        "mustSupport": true,
        "binding": {
          "name": "ListItemFlag",
          "strength": "example",
          "description": "Codes that provide further information about the reason and meaning of the item in the list",
          "valueSetReference": {
            "reference": "http://hl7.org/fhir/vs/list-item-flag"
          }
        },
        "mapping": [
          {
            "identity": "rim",
            "map": ".outBoundRelationship[typeCode=COMP].target[classCode=OBS\"].value"
          }
        ]
      },
      {
        "path": "List.entry.deleted",
        "short": "If this item is actually marked as deleted",
        "definition": "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.",
        "requirements": "The flag element may contain codes that an application processing the list does not understand. However there can be no ambiguity if a list item is actually marked as \"deleted\".",
        "min": 0,
        "max": "0",
        "type": [
          {
            "code": "boolean"
          }
        ],
        "defaultValueBoolean": false,
        "condition": [
          "lst-2"
        ],
        "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",
        "short": "When item added to list",
        "definition": "When this item was added to the list.",
        "comments": "This is only useful and meaningful when the mode is \"working\".",
        "requirements": "The date may be significant for understanding the meaning of items in a working list.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "dateTime"
          }
        ],
        "mustSupport": true,
        "mapping": [
          {
            "identity": "rim",
            "map": ".availabilityTime"
          }
        ]
      },
      {
        "path": "List.entry.item",
        "short": "Actual entry",
        "definition": "A reference to the actual resource from which data was derived.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "Reference",
            "profile": "http://hl7.org/fhir/StructureDefinition/immunization-daf-dafimmunization"
          }
        ],
        "mustSupport": true,
        "mapping": [
          {
            "identity": "rim",
            "map": ".target\nor\n.role\nor\n.role.entity"
          }
        ]
      },
      {
        "path": "List.emptyReason",
        "short": "Why list is empty",
        "definition": "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.",
        "requirements": "Allows capturing things like \"none exist\" or \"not asked\" which can be important for most lists.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "CodeableConcept"
          }
        ],
        "condition": [
          "lst-1"
        ],
        "mustSupport": true,
        "binding": {
          "name": "DAFListEmptyReason",
          "strength": "extensible",
          "description": "If a list is empty, why it is empty",
          "valueSetReference": {
            "reference": "http://hl7.org/fhir/vs/list-empty-reason"
          }
        },
        "mapping": [
          {
            "identity": "rim",
            "map": ".inboundRelationship[typeCode=SUBJ,code<{ListEmptyReason}].value[type=CD]"
          }
        ]
      }
    ]
  },
  "differential": {
    "element": [
      {
        "path": "List",
        "name": "DAFImmunizationList",
        "short": "US Realm Immunization list",
        "definition": "Information summarized from a list of other resources.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "List"
          }
        ]
      },
      {
        "path": "List.identifier",
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "Identifier"
          }
        ],
        "mustSupport": true
      },
      {
        "path": "List.code",
        "short": "Fixed code for Immunizations.",
        "definition": "Fixed code for Immunizations.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "CodeableConcept"
          }
        ],
        "fixedCodeableConcept": {
          "coding": [
            {
              "system": "http://loinc.org",
              "version": "2.48",
              "code": "11369-6"
            }
          ]
        },
        "mustSupport": true
      },
      {
        "path": "List.subject",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "Reference",
            "profile": "http://hl7.org/fhir/StructureDefinition/patient-daf-dafpatient"
          }
        ],
        "mustSupport": true
      },
      {
        "path": "List.source",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "Reference",
            "profile": "http://hl7.org/fhir/StructureDefinition/pract-daf-dafpract"
          },
          {
            "code": "Reference",
            "profile": "http://hl7.org/fhir/StructureDefinition/patient-daf-dafpatient"
          },
          {
            "code": "Reference",
            "profile": "http://hl7.org/fhir/StructureDefinition/Device"
          }
        ],
        "mustSupport": true
      },
      {
        "path": "List.date",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "dateTime"
          }
        ],
        "mustSupport": true
      },
      {
        "path": "List.mode",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "code"
          }
        ],
        "fixedCode": "snapshot",
        "mustSupport": true
      },
      {
        "path": "List.entry",
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "Element"
          }
        ],
        "mustSupport": true
      },
      {
        "path": "List.entry.flag",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "CodeableConcept"
          }
        ],
        "mustSupport": true
      },
      {
        "path": "List.entry.deleted",
        "min": 0,
        "max": "0",
        "type": [
          {
            "code": "boolean"
          }
        ]
      },
      {
        "path": "List.entry.date",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "dateTime"
          }
        ],
        "mustSupport": true
      },
      {
        "path": "List.entry.item",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "Reference",
            "profile": "http://hl7.org/fhir/StructureDefinition/immunization-daf-dafimmunization"
          }
        ],
        "mustSupport": true
      },
      {
        "path": "List.emptyReason",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "CodeableConcept"
          }
        ],
        "mustSupport": true,
        "binding": {
          "name": "DAFListEmptyReason",
          "strength": "extensible",
          "description": "If a list is empty, why it is empty",
          "valueSetReference": {
            "reference": "http://hl7.org/fhir/vs/list-empty-reason"
          }
        }
      }
    ]
  }
}