Release 4 5 Ballot

This page is part of the FHIR Specification (v4.0.1: R4 (v5.0.0-ballot: R5 Ballot - Mixed Normative and STU see ballot notes ) in it's permanent home (it will always be available at this URL). ). 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: R4B R4 R3

Using Codes Code Systems Value Sets Concept Maps Identifier Systems 4.4.1.662 Value Set http://hl7.org/fhir/ValueSet/object-lifecycle-events

Example GenomicStudy/genomicServiceRequest (JSON)

Copyright: This is an example FHIR value set based on ASTM Standard, E1762-95 (2013) HL7 RoleClass OID 2.16.840.1.113883.5.110, HL7 Role Code 2.16.840.1.113883.5.111, HL7 ParticipationType OID: 2.16.840.1.113883.5.90, HL7 ParticipationFunction codes at OID: 2.16.840.1.113883.5.88, and HL7 Security and Privacy Domain Analysis Model roles classes. These codes are excerpted from Digital Imaging and Communications in Medicine (DICOM) Standard, Part 16: Content Mapping Resource, Copyright © 2011 by the National Electrical Manufacturers Association. Source Resource XML / JSON
Security Clinical Genomics Work Group   Maturity Level : 3 N/A Trial Use Use Context Standards Status : Any This is a value set defined by the FHIR project. Summary Defining URL: http://hl7.org/fhir/ValueSet/object-lifecycle-events Version: 4.0.1 Name: ObjectLifecycleEvents Title: Definition: This example FHIR value set is comprised of lifecycle event codes. The FHIR Actor value set is based on DICOM Audit Message, ParticipantObjectDataLifeCycle; ISO Standard, TS 21089-2017; Committee: Informative Security Compartments : Patient Work Group OID: (for OID based terminology systems)
This value set is used in the following places: Resource: AuditEvent.entity.lifecycle (Coding / Extensible ) 4.4.1.662.1 Content Logical Definition This value set includes codes from the following code systems:
  • Include all codes defined in http://terminology.hl7.org/CodeSystem/dicom-audit-lifecycle Narrative
  • Include all codes defined in http://terminology.hl7.org/CodeSystem/iso-21089-lifecycle XML
  •   JSON 4.4.1.662.2 Expansion
  • TTL This expansion generated 01 Nov 2019

This value set contains 42 concepts Expansion based on http://terminology.hl7.org/CodeSystem/dicom-audit-lifecycle version 20100826 Code System Display Definition 1 http://terminology.hl7.org/CodeSystem/dicom-audit-lifecycle Origination / Creation 2 http://terminology.hl7.org/CodeSystem/dicom-audit-lifecycle Import / Copy 3 http://terminology.hl7.org/CodeSystem/dicom-audit-lifecycle Amendment 4 http://terminology.hl7.org/CodeSystem/dicom-audit-lifecycle Verification 5 http://terminology.hl7.org/CodeSystem/dicom-audit-lifecycle Translation 6 http://terminology.hl7.org/CodeSystem/dicom-audit-lifecycle Access / Use 7 http://terminology.hl7.org/CodeSystem/dicom-audit-lifecycle De-identification 8 http://terminology.hl7.org/CodeSystem/dicom-audit-lifecycle Aggregation / summarization / derivation 9 http://terminology.hl7.org/CodeSystem/dicom-audit-lifecycle Report 10 http://terminology.hl7.org/CodeSystem/dicom-audit-lifecycle Export 11 http://terminology.hl7.org/CodeSystem/dicom-audit-lifecycle Disclosure 12 http://terminology.hl7.org/CodeSystem/dicom-audit-lifecycle Receipt of disclosure 13 http://terminology.hl7.org/CodeSystem/dicom-audit-lifecycle Archiving 14 http://terminology.hl7.org/CodeSystem/dicom-audit-lifecycle Logical deletion 15 http://terminology.hl7.org/CodeSystem/dicom-audit-lifecycle Permanent erasure / Physical destruction access http://terminology.hl7.org/CodeSystem/iso-21089-lifecycle Access/View Record Lifecycle Event Occurs when an agent causes the system to obtain and open a record entry for inspection or review. hold http://terminology.hl7.org/CodeSystem/iso-21089-lifecycle Add Legal Hold Record Lifecycle Event Occurs when an agent causes the system to tag or otherwise indicate special access management and suspension of record entry deletion/destruction, if deemed relevant to a lawsuit or which are reasonably anticipated to be relevant or to fulfill organizational policy under the legal doctrine of “duty to preserve”. amend http://terminology.hl7.org/CodeSystem/iso-21089-lifecycle Amend (Update) Record Lifecycle Event Occurs when an agent makes any change to record entry content currently residing in storage considered permanent (persistent). archive http://terminology.hl7.org/CodeSystem/iso-21089-lifecycle Archive Record Lifecycle Event Occurs when an agent causes the system to create and move archive artifacts containing record entry content, typically to long-term offline storage. attest http://terminology.hl7.org/CodeSystem/iso-21089-lifecycle Attest Record Lifecycle Event Occurs when an agent causes the system to capture the agent’s digital signature (or equivalent indication) during formal validation of record entry content. decrypt http://terminology.hl7.org/CodeSystem/iso-21089-lifecycle Decrypt Record Lifecycle Event Occurs when an agent causes the system to decode record entry content from a cipher. deidentify http://terminology.hl7.org/CodeSystem/iso-21089-lifecycle De-Identify (Anononymize) Record Lifecycle Event Occurs when an agent causes the system to scrub record entry content to reduce the association between a set of identifying data and the data subject in a way that might or might not be reversible. deprecate http://terminology.hl7.org/CodeSystem/iso-21089-lifecycle Deprecate Record Lifecycle Event Occurs when an agent causes the system to tag record entry(ies) as obsolete, erroneous or untrustworthy, to warn against its future use. destroy http://terminology.hl7.org/CodeSystem/iso-21089-lifecycle Destroy/Delete Record Lifecycle Event Occurs when an agent causes the system to permanently erase record entry content from the system. disclose http://terminology.hl7.org/CodeSystem/iso-21089-lifecycle Disclose Record Lifecycle Event Occurs when an agent causes the system to release, transfer, provision access to, or otherwise divulge record entry content. encrypt http://terminology.hl7.org/CodeSystem/iso-21089-lifecycle Encrypt Record Lifecycle Event Occurs when an agent causes the system to encode record entry content in a cipher. extract http://terminology.hl7.org/CodeSystem/iso-21089-lifecycle Extract Record Lifecycle Event Occurs when an agent causes the system to selectively pull out a subset of record entry content, based on explicit criteria. link http://terminology.hl7.org/CodeSystem/iso-21089-lifecycle Link Record Lifecycle Event Occurs when an agent causes the system to connect related record entries. merge http://terminology.hl7.org/CodeSystem/iso-21089-lifecycle Merge Record Lifecycle Event Occurs when an agent causes the system to combine or join content from two or more record entries, resulting in a single logical record entry. originate http://terminology.hl7.org/CodeSystem/iso-21089-lifecycle Originate/Retain Record Lifecycle Event Occurs when an agent causes the system to: a) initiate capture of potential record content, and b) incorporate that content into the storage considered a permanent part of the health record. pseudonymize http://terminology.hl7.org/CodeSystem/iso-21089-lifecycle Pseudonymize Record Lifecycle Event Occurs when an agent causes the system to remove record entry content to reduce the association between a set of identifying data and the data subject in a way that may be reversible. reactivate http://terminology.hl7.org/CodeSystem/iso-21089-lifecycle Re-activate Record Lifecycle Event Occurs when an agent causes the system to recreate or restore full status to record entries previously deleted or deprecated. receive http://terminology.hl7.org/CodeSystem/iso-21089-lifecycle Receive/Retain Record Lifecycle Event Occurs when an agent causes the system to a) initiate capture of data content from elsewhere, and b) incorporate that content into the storage considered a permanent part of the health record. reidentify http://terminology.hl7.org/CodeSystem/iso-21089-lifecycle Re-identify Record Lifecycle Event Occurs when an agent causes the system to restore information to data that allows identification of information source and/or information subject. unhold http://terminology.hl7.org/CodeSystem/iso-21089-lifecycle Remove Legal Hold Record Lifecycle Event Occurs when an agent causes the system to remove a tag or other cues for special access management had required to fulfill organizational policy under the legal doctrine of “duty to preserve”. report Raw JSON http://terminology.hl7.org/CodeSystem/iso-21089-lifecycle Report (Output) Record Lifecycle Event Occurs when an agent causes the system to produce and deliver record entry content in a particular ( canonical form and manner. restore http://terminology.hl7.org/CodeSystem/iso-21089-lifecycle Restore Record Lifecycle Event Occurs when an agent causes the system to recreate record entries and their content from a previous created archive artefact. transform http://terminology.hl7.org/CodeSystem/iso-21089-lifecycle Transform/Translate Record Lifecycle Event Occurs when an agent causes the system to change the form, language or code system used to represent record entry content. transmit http://terminology.hl7.org/CodeSystem/iso-21089-lifecycle Transmit Record Lifecycle Event Occurs when an agent causes the system to send record entry content from one (EHR/PHR/other) system to another. unlink http://terminology.hl7.org/CodeSystem/iso-21089-lifecycle Unlink Record Lifecycle Event Occurs when an agent causes the system to disconnect two or more record entries previously connected, rendering them separate (disconnected) again. unmerge http://terminology.hl7.org/CodeSystem/iso-21089-lifecycle Unmerge Record Lifecycle Event Occurs when an agent causes the system to reverse a previous record entry merge operation, rendering them separate again. verify + also see JSON Format Specification http://terminology.hl7.org/CodeSystem/iso-21089-lifecycle Verify Record Lifecycle Event Occurs when an agent causes the system to confirm compliance of data or data objects with regulations, requirements, specifications, or other imposed conditions based on organizational policy.   )

See the full registry of value sets defined as part of FHIR. ServiceRequest - Genomic Example 

{
  "resourceType": "ServiceRequest",
  "id": "genomicServiceRequest",
  "text": {
    "status": "generated",
    "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p><b>Generated Narrative</b></p><div style=\"display: inline-block; background-color: #d9e0e7; padding: 6px; margin: 4px; border: 1px solid #8da1b4; border-radius: 5px; line-height: 60%\"><p style=\"margin-bottom: 0px\">Resource &quot;genomicServiceRequest&quot; </p></div><p><b>identifier</b>: Laboratory Accession ID: 111111111</p><p><b>status</b>: active</p><p><b>intent</b>: plan</p><p><b>code</b>: Carrier detection, molecular genetics (procedure) <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> (<a href=\"https://browser.ihtsdotools.org/\">SNOMED CT</a>#3981005)</span></p><p><b>subject</b>: <a href=\"Patient-denovoChild.html\">Patient/denovoChild</a> &quot; DOE&quot;</p><p><b>encounter</b>: <a href=\"Encounter-denovoEncounter.html\">Encounter/denovoEncounter</a></p></div>"
  },
  "identifier": [
    {
      "type": {
        "coding": [
          {
            "system": "http://terminology.hl7.org/CodeSystem/v2-0203",
            "code": "LACSN"
          }
        ],
        "text": "Laboratory Accession ID"
      },
      "system": "http://www.somesystemabc.net/identifiers/serviceRequests",
      "value": "111111111"
    }
  ],
  "status": "active",
  "intent": "plan",
  "code": {
    "concept": {
      "coding": [
        {
          "system": "http://snomed.info/sct",
          "code": "3981005",
          "display": "Carrier detection, molecular genetics (procedure)"
        }
      ]
    }
  },
  "subject": {
    "reference": "Patient/denovoChild"
  },
  "encounter": {
    "reference": "Encounter/denovoEncounter"
  }
}

Explanation of the columns that may appear on this page: Lvl A few code lists that FHIR defines are hierarchical - each code is assigned a level. For value sets, levels are mostly used Usage note: every effort has been made to organize codes for user convenience, but may follow code system hierarchy - see Code System for further information Source The source of the definition of the code (when the value set draws in codes defined elsewhere) Code The code (used as the code in the resource instance). If the code is in italics, this indicates ensure that the code is examples are correct and useful, but they are not selectable ('Abstract') Display The display (used in the display element of a Coding ). If there is no display, implementers should not simply display the code, but map the concept into their application Definition An explanation of the meaning normative part of the concept Comments Additional notes about how to use the code specification.