HL7 FHIR Implementation Guide: SHR Core, Release 0.6 - US Realm (Draft for Comment 1)

HL7 FHIR Implementation Guide: SHR Core, Release 0.6 - US Realm (Draft for Comment 1) FHIR Profiles - Local Development build (v0.6.0). See the Directory of published versions

Primary local value sets used in this Implementation Guide

Name Definition
AbnormalBodyStructureVS

A morphologically altered or physiology.

AgeGroupVS

Descriptions of life periods such as

AnatomicalDirectionVS

Terms that specify anatomical direction.

AttributionCategoryVS

Whether the adverse event is attributed to a treatment, course of the disease, medical error, unrelated to either, or unknown.

BloodPressureBodyLocationVS

Body locations for blood pressure measurement

BloodPressureCuffSizeVS

Sizes of blood pressure cuffs.

BloodPressureMethodVS

Method used to determine blood pressure.

BodyHeightLengthMethodVS

Method used to determine body height or length.

BodyHeightLengthUnitsVS

Codes representing acceptable units for body height or length.

BodyHeightPreconditionVS

Circumstance for measuring body height.

BodyLocationVS

Codes that describe normal and pathologic anatomic systems, regions, cavities, and spaces. The code set includes codes from the SNOMED CT hierarchy descending from 123037004 ‘Body Structure’.

Body location is a flexible structure that allows the location to be determined by a single code, or a code plus laterality and/or orientation. The body location can also be specified in relation to one or more body landmarks. SNOMED CT is used in all cases.

  • Code only: The code should include (precoordinate) laterality and/orientation to the degree necessary to completely specify the body location.
  • Code plus laterality and/or orientation: The basic code augmented by codes specifying the body side and/or anatomical orientation.
  • Relation to landmark: The location relative to a landmark is specified by:
  • Establishing the location and type of landmark using a body site code and optional laterality/orientation, and
  • Specifying the direction and distance from the landmark to the body location.

Note that BodyLocation is a data type (a reusable structure), not a stand-alone entity. The concept is similar to how a postal address can apply to a person, location, or organization. This contrasts with FHIR’s stand-alone BodySite (aka BodyStructure in r4) which ‘is not … intended for describing the type of anatomical location but rather a specific body site on a specific patient’ (FHIR 3.5).

BodyPositionVS

Human body positions associated with actions or observations.

BodyTemperatureBodyLocationVS

Body sites for body temperature measurement.

BodyTemperatureMethodVS

Method used to determine body temperature.

BodyWeightMethodVS

Method used to determine body weight.

BodyWeightPreconditionVS

Circumstances for body weight measurement. The choices are limited by availability of SNOMED terms, and could contain terms like pre- and post-dialysis, mother ante- and post-delivery, etc.

BodyWeightUnitsVS

Codes representing the acceptable units for body weight measurement.

CardiopulmonaryPreconditionVS

Circumstances for cardiopulmonary measurements.

ClockFaceDirectionVS

The relative direction of an object described using the analogy of a 12-hour clock to describe angles and directions. One imagines a clock face lying either upright or flat in front of oneself, and identifies the twelve hour markings with the directions in which they point.

ComorbidConditionVS

SNOMED and ICD-10 codes for common comorbid conditions. Aligns with Elixhauser comorbidity scale. ICD-10 codes are drawn from https://www.hcup-us.ahrq.gov/toolssoftware/comorbidityicd10/comformat_icd10cm_2019_1.txt

ConditionCategoryVS

A category assigned to the condition, for example, a disease, concern, symptom, functional impairment, or structural abnormality. Extends http://hl7.org/fhir/ValueSet/condition-category by including all codes from the corresponding code system, namely, http://terminology.hl7.org/CodeSystem/condition-category. Extensions are based on http://fhir.org/guides/argonaut/ValueSet/condition-category, but substituting SNOMED CT codes.

CongenitalAbnormalitiesVS
DiagnosticImagingVS

Codes describing imaging procedures. Value set includes SNOMED codes descending from 363679005 ‘Imaging (procedure)’.

ECOGPerformanceStatusVS

Value set for Eastern Cooperative Oncology Group performance status. Values range from grade 0 (Asymptomatic) to grade 5 (Dead).

GestationalTimePeriodVS

Time periods of pregnancy

GradedFrequencyVS

Answers to ‘how often’ questions. A 5-value qualitative scale of frequency of an event equivalent to LL1016-6, LL1024-0, LL346-8.

HeartRateBodyLocationVS

Body locations for respiration rate measurement

HeartRateMethodVS

Method used to determine the heart rate.

KarnofskyPerformanceStatusVS

Value set for Karnofsky Performance Status, with codes for each decade from 100 to 0. Higher scores are associated with better functional status, with 100 representing no symptoms or evidence of disease, and 0 representing death. This value set corresponds to LOINC list LL4986-7

LandmarkTypeVS

The type of feature that constitutes the landmark, for example, particularly if the landmark is an acquired body structure or physical object. The landmark type value set is part of BodyLocation, a flexible structure that allows the location to be determined by a single code, or a code plus laterality and/or orientation. The body location can also be specified in relation to one or more body landmarks. SNOMED CT is used in all cases.

  • Code only: The code should include (precoordinate) laterality and/orientation to the degree necessary to completely specify the body location.
  • Code plus laterality and/or orientation: The basic code augmented by codes specifying the body side and/or anatomical orientation.
  • Relation to landmark: The location relative to a landmark is specified by:
  • Establishing the location and type of landmark using a body site code and optional laterality/orientation, and
  • Specifying the direction and distance from the landmark to the body location.

Note that BodyLocation is a data type (a reusable structure), not a stand-alone entity. The concept is similar to how a postal address can apply to a person, location, or organization. This contrasts with FHIR’s stand-alone BodySite (aka BodyStructure in r4) which ‘is not … intended for describing the type of anatomical location but rather a specific body site on a specific patient’ (FHIR 3.5).

LanguageQualifierVS

A code indicating whether the language is preferred, secondary, or practiced in an unconventional or limited way.

LateralityVS

Terms that specify the side of the body. The laterality value set is part of BodyLocation, a flexible structure that allows the location to be determined by a single code, or a code plus laterality and/or orientation. The body location can also be specified in relation to one or more body landmarks. SNOMED CT is used in all cases.

  • Code only: The code should include (precoordinate) laterality and/orientation to the degree necessary to completely specify the body location.
  • Code plus laterality and/or orientation: The basic code augmented by codes specifying the body side and/or anatomical orientation.
  • Relation to landmark: The location relative to a landmark is specified by:
  • Establishing the location and type of landmark using a body site code and optional laterality/orientation, and
  • Specifying the direction and distance from the landmark to the body location.

Note that BodyLocation is a data type (a reusable structure), not a stand-alone entity. The concept is similar to how a postal address can apply to a person, location, or organization. This contrasts with FHIR’s stand-alone BodySite (aka BodyStructure in r4) which ‘is not … intended for describing the type of anatomical location but rather a specific body site on a specific patient’ (FHIR 3.5).

MedDRAVS
MedicationNonAdherenceReasonVS
OrientationVS

Terms that specify anatomical orientation. The orientation value set is part of BodyLocation, a flexible structure that allows the location to be determined by a single code, or a code plus laterality and/or orientation. The body location can also be specified in relation to one or more body landmarks. SNOMED CT is used in all cases.

  • Code only: The code should include (precoordinate) laterality and/orientation to the degree necessary to completely specify the body location.
  • Code plus laterality and/or orientation: The basic code augmented by codes specifying the body side and/or anatomical orientation.
  • Relation to landmark: The location relative to a landmark is specified by:
  • Establishing the location and type of landmark using a body site code and optional laterality/orientation, and
  • Specifying the direction and distance from the landmark to the body location.

Note that BodyLocation is a data type (a reusable structure), not a stand-alone entity. The concept is similar to how a postal address can apply to a person, location, or organization. This contrasts with FHIR’s stand-alone BodySite (aka BodyStructure in r4) which ‘is not … intended for describing the type of anatomical location but rather a specific body site on a specific patient’ (FHIR 3.5).

OxygenSaturationBodyLocationVS

Body locations for respiration rate measurement

OxygenSaturationMethodVS

Method used to determine oxygen saturation.

PerformanceGradingScaleVS

A simple performance grading scale. Also useful for grading quality and knowledge.

QuantitativeResultInterpretationVS

Interpretations of abnormal quantitative results.

RadiationProcedureVS

Codes describing radiation therapy procedures. The value set includes a limited set of radiation modality codes from SNOMED CT, however, ICD-10-PCS code from Section D (Radiation Therapy) and appropriate CPT radiation procedure codes are also considered compliant. CPT codes are not explicitly included due to licensing restrictions. ICD-10-PCS codes are not included because they are not currently supported by the FHIR IG Publishing tool.

RadiationTargetBodySiteVS

Codes for body sites that can be targets of radiation therapy. This list of sites is based on Commission on Cancer’s ‘Standards for Oncology Registry Entry  - STORE 2018’. This value set contains SNOMED CT equivalent terms.

ResearchSubjectTerminationReasonVS

The reason for a research subject leaving a research study.

RespiratoryRateMethodVS

Method used to determine respiration rate.

SettingVS

What type of place is found at a given location. More than one descriptor may be applicable.

StudyArmTypeVS

The role of each arm in the clinical trial.

FHIR is currently unable to handle values from NCI Thesaurus, so no values are listed in the Expansion, below. The values ARE in the downloads. For convenience, here is a listing of values in this value set: NCIT#C94487 ‘Intervention Group’ NCIT#C68609 ‘Active Comparator’ NCIT#C49648 ‘Placebo Control’ NCIT#C116527 ‘Sham Intervention’

SurgicalBodyLocationRoleVS

Roles of body site in surgical procedures. Value set includes codes from the SNOMED hierarchy descending from 363704007 ‘Procedure site’ and descending from 272737002 ‘Site of (attribute)’.

SurgicalMethodVS

Codes describing additional information about the method of the surgery. Includes the technique used to reach the site of the procedure, and actions taken during the surgery. Value set includes SNOMED codes descending from 103379005 ‘Procedural approach’ and descending from 129284003 ‘Surgical action’.

SurgicalProcedureVS

Codes describing surgical procedures. Includes codes from SNOMED CT under the hierarchy of 387713003 ‘Surgical procedure’. Codes from ICD-10-PCS and CPT are acceptable. CPT codes are not listed here due to intellectual property restrictions. ICD-10-PCS codes are not listed because of a limitation in the FHIR Implementation Guide publisher. For CPT and ICD-10-PCS, only codes representing surgical procedures should be included.

TreatmentIntentVS

The purpose of a treatment. The value set includes ‘curative’ and ‘palliative’. Curative is defined as any treatment meant to reduce or control a disease process, even if a ‘cure’ is not anticipated. Palliative includes treatments meant to reduce symptoms and side effects, such as antiemetics.

TreatmentTerminationReasonVS

Values used to describe the reasons for stopping a treatment. Includes code for ‘treatment completed’ as well as codes for unplanned (early) stoppage. Applies to medications and other treatments that take place over a period of time, such as radiation treatments.

UnitsOfLengthVS

Units of measure related to length or distance.

YesNoUnknownVS

A value set containing yes, no, and unknown.

YesNoVS

Value set indicating yes or no (values drawn from Snomed CT), equivalent to LL361-7.

Primary external value sets used in this Implementation Guide

Name Definition
AdministrativeGender

The gender of a person used for administrative purposes.

AdmitSource

This value set defines a set of codes that can be used to indicate from where the patient came in.

AdverseEventCategory

Overall categorization of the event, e.g. real or potential

AdverseEventCausality

TODO

AdverseEventCausalityAssessment

TODO

AdverseEventCausalityMethod

TODO

AdverseEventCausalityResult

TODO

AdverseEventOutcome

TODO (and should this be required?)

AdverseEventSeriousness

Overall seriousness of this event for the patient

All Security Labels

A single value set for all security labels defined by FHIR.

AllergyIntoleranceCategory

Category of an identified substance.

AllergyIntoleranceClinicalStatus

The clinical status of the allergy or intolerance.

AllergyIntoleranceCriticality

Estimate of the potential clinical harm, or seriousness, of a reaction to an identified substance.

AllergyIntoleranceSeverity

Clinical assessment of the severity of a reaction event as a whole, potentially considering multiple different manifestations.

AllergyIntoleranceType

Identification of the underlying physiological mechanism for a Reaction Risk.

AllergyIntoleranceVerificationStatus

Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance.

AnimalBreeds

This example value set defines a set of codes that can be used to indicate breeds of species.

AnimalSpecies

This example value set defines a set of codes that can be used to indicate species of animal patients.

AppointmentStatus

The free/busy status of an appointment.

Common Languages

This value set includes common codes from BCP-47 (http://tools.ietf.org/html/bcp47)

Common Tags

Common Tag Codes defined by FHIR project

CompositionAttestationMode

The way in which a person authenticated a composition.

CompositionStatus

The workflow/clinical status of the composition.

Condition Clinical Status Codes

Preferred value set for Condition Clinical Status.

Condition Stage

Example value set for stages of cancer and other conditions

Condition/Diagnosis Severity

Preferred value set for Condition/Diagnosis severity grading

Condition/Problem/Diagnosis Codes

Example value set for Condition/Problem/Diagnosis codes

ConditionVerificationStatus

The verification status to support or decline the clinical status of the condition or diagnosis.

ContactEntityType

This example value set defines a set of codes that can be used to indicate the purpose for which you would contact a contact party.

Coverage Type and Self-Pay Codes

This value set includes Coverage Type codes.

DataAbsentReason

Used to specify why the normally expected content of the data element is missing.

Designation Use

Details of how a designation would be used

DeviceSafety

Codes used to identify medical devices safety characteristics. These codes are taken from the NCI Thesaurus and are provided here as a suggestive example.

DiagnosisRole

This value set defines a set of codes that can be used to express the role of a diagnosis on the Encounter or EpisodeOfCare record.

Diagnostic Service Section Codes

This value set includes all the codes in HL7 v2 table 0074.

DiagnosticReportStatus

The status of the diagnostic report as a whole.

Diet

This value set defines a set of codes that can be used to indicate dietary preferences or restrictions a patient may have.

DigitalMediaType

Whether the media is a photo, video, or audio

DischargeDisposition

This value set defines a set of codes that can be used to where the patient left the hospital.

Document Class Value Set

This is the code specifying the high-level kind of document (e.g. Prescription, Discharge Summary, Report, etc.). The Document Class value set is reproduced from HITSP C80 Table 2-144 Document Class Value Set Definition. Note: Class code for documents comes from LOINC, and is based upon one of the following:The type of service described by the document. It is described at a very high level in Section 7.3 of the LOINC Manual. The type study performed. It was determined by identifying modalities for study reports. The section of the chart where the document is placed. It was determined from the SETs created for Claims Attachment requests.

Document Section Codes

Document section codes (LOINC codes used in CCDA sections).

Document Type Value Set

This is the code specifying the precise type of document (e.g. Pulmonary History and Physical, Discharge Summary, Ultrasound Report, etc.). The Document Type value set includes all LOINC values listed in HITSP C80 Table 2-144 Document Class Value Set Definition above used for Document Class, and all LOINC values whose SCALE is DOC in the LOINC database.

DocumentReference Format Code Set

The value set is defined to be the set of format codes defined by the IHE Technical Framework, and also including additional format codes defined by the HL7. The value set is listed in HITSP C80 Table 2-153 Format Code Value Set Definition, with additions published later by IHE as published at http://wiki.ihe.net/index.php?title=IHE_Format_Codes and with additions published later by HL7 as published at http://wiki.hl7.org/index.php?title=CDA_Format_Codes_for_IHE_XDS. This is the code specifying the technical format of the document. Along with the typeCode, it should provide sufficient information to allow any potential document consumer to know if it will be able to process the document. The code shall be sufficiently specific to ensure processing/display by identifying a document encoding, structure and template. The actual list of codes here is incomplete

DocumentReferenceStatus

The status of the document reference.

DocumentRelationshipType

The type of relationship between documents.

Encounter Reason Codes

This examples value set defines the set of codes that can be used to indicate reasons for an encounter.

EncounterLocationStatus

The status of the location.

EncounterStatus

Current state of the encounter

EpisodeOfCareStatus

The status of the episode of care.

EpisodeOfCareType

This example value set defines a set of codes that can be used to express the usage type of an EpisodeOfCare record.

EventStatus

Codes identifying the stage lifecycle stage of a event

FHIR Device Types

Codes used to identify medical devices. Include codes from SNOMED CT where concept is-a 49062001 (Device) and is provided as a suggestive example.

FHIR Document Class Codes

LOINC codes for Document Kind, taken from the LOINC document ontology.

FHIR Document Type Codes

FHIR Document Codes - all LOINC codes where scale type = ‘DOC’.

FHIR Specimen Collection Method

This example value set defines a set of codes that can be used to indicate the method of collection of a specimen. It includes values from HL7 v2 table 0048.

FHIRDeviceStatus

The availability status of the device.

FHIRSubstanceStatus

A code to indicate if the substance is actively used

Facility Type Code Value Set

This is the code representing the type of organizational setting where the clinical encounter, service, interaction, or treatment occurred. The value set used for Healthcare Facility Type has been defined by HITSP to be the value set reproduced from HITSP C80 Table 2-147.

FilterOperator

The kind of operation to perform as a part of a property based filter.

Financial Resource Status Codes

This value set includes Status codes.

GenderStatus

This example value set defines a set of codes that can be used to indicate the current state of the animal’s reproductive organs.

GroupType

Types of resources that are part of group

Jurisdiction ValueSet

This value set defines a base set of codes for country and region, for indicating where a resource is intended to be used

LOINC Codes

This value set includes all LOINC codes

LOINC Diagnostic Report Codes

This value set includes all the LOINC codes which relate to Diagnostic Observations.

Language codes with language and optionally a region modifier

This value set includes codes from BCP-47. This value set matches the ONC 2015 Edition LanguageCommunication data element value set within C-CDA to use a 2 character language code if one exists, and a 3 character code if a 2 character code does not exist. It points back to RFC 5646, however only the language codes are required, all other elements are optional.

LinkType

The type of link between this patient resource and another patient resource.

List Empty Reasons

General reasons for a list to be empty. Reasons are either related to a summary list (i.e. problem or medication list) or to a workflow related list (i.e. consultation list).

List Order Codes

Base values for the order of the items in a list resource.

ListMode

The processing mode that applies to this list

LocationMode

Indicates whether a resource instance represents a specific location or a class of locations.

LocationStatus

Indicates whether the location is still in use.

LocationType

This example value set defines a set of codes that can be used to indicate the physical form of the Location.

Marital Status Codes

This value set defines the set of codes that can be used to indicate the marital status of a person.

Media Collection View/Projection

Codes defined in SNOMED CT that can be used to record Media Recording views.

Media SubType

Detailed information about the type of the image - its kind, purpose, or the kind of equipment used to generate it.

Medication Clinical Drug (RxNorm)

All prescribable medication formulations represented using either a ‘generic’ or ‘brand-specific’ concept. This includes RxNorm codes whose Term Type is SCD (semantic clinical drug), SBD (semantic brand drug), GPCK (generic pack), BPCK (brand pack), SCDG (semantic clinical drug group), SBDG (semantic brand drug group), SCDF (semantic clinical drug form), or SBDF (semantic brand drug form)

MedicationAdministrationCategory

A coded concept describing where the medication administered is expected to occur

MedicationAdministrationStatus

A set of codes indicating the current status of a MedicationAdministration.

MedicationContainer

A coded concept defining the kind of container a medication package is packaged in

MedicationRequestIntent

The kind of medication order

MedicationRequestPriority

Identifies the level of importance to be assigned to actioning the request

MedicationRequestStatus

A coded concept specifying the state of the prescribing event. Describes the lifecycle of the prescription

MedicationStatementCategory

A coded concept identifying where the medication included in the medicationstatement is expected to be consumed or administered

MedicationStatementStatus

A coded concept indicating the current status of a MedicationStatement.

MedicationStatementTaken

A coded concept identifying level of certainty if patient has taken or has not taken the medication

MedicationStatus

A coded concept defining if the medication is in active use

Observation Category Codes

Observation Category codes.

Observation Interpretation Codes

This value set defines the set of codes that can be used to indicate the meaning/use of a reference range.

Observation Methods

Observation Method codes from SNOMED CT where concept is-a 272394005 (Technique (qualifier value)) or is-a 129264002 (Action (qualifier value)) or is-a 386053000 (Evaluation procedure(procedure))

Observation Reference Range Applies To Codes

This value set defines a set of codes that can be used to indicate the a particular target population the reference range applies to.

Observation Reference Range Meaning Codes

This value set defines a set of codes that can be used to indicate the meaning/use of a reference range for a particular target population.

ObservationRelationshipType

Codes specifying how two observations are related.

ObservationStatus

Codes providing the status of an observation.

OrganizationType

This example value set defines a set of codes that can be used to indicate a type of organization.

Participant Roles

Roles of Participants that may be included in a CarePlan.Participants, or in an EpisodeOfCare.CareTeam. Defined as: Is a Person, Healthcare professional (occupation) or Healthcare related organization (qualifier value).

ParticipantRequired

Is the Participant required to attend the appointment.

ParticipantType

This value set defines a set of codes that can be used to indicate how an individual participates in an encounter.

ParticipationStatus

The Participation status of an appointment.

PatientRelationshipType

A set of codes that can be used to indicate the relationship between a Patient and a Related Person.

Practice Setting Code Value Set

This is the code representing the clinical specialty of the clinician or provider who interacted with, treated, or provided a service to/for the patient. The value set used for clinical specialty has been limited by HITSP to the value set reproduced from HITSP C80 Table 2-149 Clinical Specialty Value Set Definition.

PractitionerSpecialty

This example value set defines a set of codes that can be used to indicate the specialty of a Practitioner.

Problem Value Set

This describes the problem. Diagnosis/Problem List is broadly defined as a series of brief statements that catalog a patient’s medical, nursing, dental, social, preventative and psychiatric events and issues that are relevant to that patient’s healthcare (e.g., signs, symptoms, and defined conditions)

Procedure Category Codes (SNOMED CT)

Procedure Category code: A selection of relevant SNOMED CT codes.

Procedure Codes (SNOMED CT)

Procedure Code: All SNOMED CT procedure codes.

Procedure Device Action Codes

Example codes indicating the change that happened to the device during the procedure. Note that these are in no way complete and may not even be appropriate for some uses.

Procedure Follow up Codes (SNOMED CT)

Procedure follow up codes: a selection of SNOMED CT codes relevant to procedure follow up.

Procedure Not Performed Reason (SNOMED-CT)

Situation codes describing the reason that a procedure, which might otherwise be expected, was not performed, or a procedure that was started and was not completed. Consists of SNOMED CT codes, children of procedure contraindicated (183932001), procedure discontinued (416406003), procedure not done (416237000), procedure not indicated (428119001), procedure not offered (416064006), procedure not wanted (416432009), procedure refused (183944003), and procedure stopped (394908001).

Procedure Outcome Codes (SNOMED CT)

Procedure Outcome code: A selection of relevant SNOMED CT codes.

Procedure Performer Role Codes

This examples value set defines the set of codes that can be used to indicate a role of procedure performer.

Procedure Reason Codes

This examples value set defines the set of codes that can be used to indicate a reasons for a procedure.

ProvenanceActivityType

This value set contains representative Activity Type codes, which includes codes from the HL7 DocumentCompletion, ActStatus, and DataOperations code system, W3C PROV-DM and PROV-N concepts and display names, several HL7 Lifecycle Event codes for which there are agreed upon definitions, and non-duplicated codes from the HL7 Security and Privacy Ontology Operations codes.

ProvenanceEntityRole

How an entity was used in an activity.

PublicationStatus

The lifecycle status of a Value Set or Concept Map.

QuantityComparator

How the Quantity should be understood and represented.

Questionnaire Answer Codes

Example list of codes for answers to questions. (Not complete or necessarily appropriate.)

Questionnaire Question Codes

Example list of codes for questions and groups of questions. (Not necessarily complete or appropriate.)

QuestionnaireItemType

Distinguishes groups from questions and display text and indicates data type for questions

QuestionnaireResponseStatus

Lifecycle status of the questionnaire response.

Reason Medication Given Codes

This value set is provided as an example. The value set to instantiate this attribute should be drawn from a robust terminology code system that consists of or contains concepts to support the medication process.

RequestIntent

Codes indicating the degree of authority/intentionality associated with a request

RequestPriority

The clinical priority of a diagnostic order.

RequestStatus

Codes identifying the stage lifecycle stage of a request

ResearchStudyStatus

Codes that convey the current status of the research study

ResearchSubjectStatus

Indicates the progression of a study subject through a study

ResourceType

One of the resource types defined as part of FHIR.

SNOMED CT Administration Method Codes

This value set includes some method codes from SNOMED CT - provided as an exemplar

SNOMED CT Clinical Findings

This value set includes all the “Clinical finding” SNOMED CT codes - concepts where concept is-a 404684003 (Clinical finding (finding)).

SNOMED CT Drugs not taken/completed Codes

This value set includes some not taken reason codes from SNOMED CT - provided as an exemplar

SNOMED CT Form Codes

This value set includes all dose form codes from SNOMED CT - provided as an exemplar.

SNOMED CT Medication As Needed Reason Codes

This value set includes all clinical findings from SNOMED CT - provided as an exemplar value set.

SNOMED CT Medication Codes

This value set includes all drug or medicament substance codes and all pharmaceutical/biologic products from SNOMED CT - provided as an exemplar value set.

SNOMED CT Patient Referral

This value set includes all SNOMED CT Patient Referral.

SNOMED CT Reason Medication Not Given Codes

This value set includes all medication refused, medication not administered, and non administration of necessary drug or medicine codes from SNOMED CT - provided as an exemplar value set.

SNOMED CT Route Codes

This value set includes all Route codes from SNOMED CT - provided as an exemplar.

SecurityRoleType

This example FHIR value set is comprised of example Actor Type codes, which can be used to value FHIR agents, actors, and other role elements such as those specified in financial transactions. The FHIR Actor value set is based on DICOM Audit Message, C402; ASTM Standard, E1762-95 [2013]; selected codes and derived actor roles from HL7 RoleClass OID 2.16.840.1.113883.5.110; HL7 Role Code 2.16.840.1.113883.5.111, including AgentRoleType; HL7 ParticipationType OID: 2.16.840.1.113883.5.90; and HL7 ParticipationFunction codes OID: 2.16.840.1.113883.5.88. This value set includes, by reference, role codes from external code systems: NUCC Health Care Provider Taxonomy OID: 2.16.840.1.113883.6.101; North American Industry Classification System [NAICS]OID: 2.16.840.1.113883.6.85; IndustryClassificationSystem 2.16.840.1.113883.1.11.16039; and US Census Occupation Code OID: 2.16.840.1.113883.6.243 for relevant recipient or custodian codes not included in this value set. If no source is indicated in the definition comments, then these are example FHIR codes. It can be extended with appropriate roles described by SNOMED as well as those described in the HL7 Role Based Access Control Catalog and the HL7 Healthcare (Security and Privacy) Access Control Catalog. In Role-Based Access Control (RBAC), permissions are operations on an object that a user wishes to access. Permissions are grouped into roles. A role characterizes the functions a user is allowed to perform. Roles are assigned to users. If the user’s role has the appropriate permissions to access an object, then that user is granted access to the object. FHIR readily enables RBAC, as FHIR Resources are object types and the CRUDE events (the FHIR equivalent to permissions in the RBAC scheme) are operations on those objects. In Attribute-Based Access Control (ABAC), a user requests to perform operations on objects. That user’s access request is granted or denied based on a set of access control policies that are specified in terms of attributes and conditions. FHIR readily enables ABAC, as instances of a Resource in FHIR (again, Resources are object types) can have attributes associated with them. These attributes include security tags, environment conditions, and a host of user and object characteristics, which are the same attributes as those used in ABAC. Attributes help define the access control policies that determine the operations a user may perform on a Resource (in FHIR) or object (in ABAC). For example, a tag (or attribute) may specify that the identified Resource (object) is not to be further disclosed without explicit consent from the patient.

ServiceCategory

This value set defines an example set of codes that can be used to classify groupings of service-types/specialties.

ServiceType

This value set defines an example set of codes of service-types.

SpecialArrangements

This value set defines a set of codes that can be used to indicate the kinds of special arrangements in place for a patients visit.

SpecialCourtesy

This value set defines a set of codes that can be used to indicate special courtesies provided to the patient.

SpecimenContainer

Containers which may hold specimens or specimen containers. Include codes SNOMED CT(http://snomed.info/sct) where concept is-a 434711009 (Specimen container (physical object))

SpecimenProcessingProcedure

The technique that is used to perform the process or preserve the specimen.

SpecimenStatus

Codes providing the status/availability of a specimen.

Substance Category Codes

Substance category codes

Substance Code

This value set contains concept codes for specific substances. It includes codes from SNOMED where concept is-a 105590001 (Substance (substance)) adn where concept is-a 373873005 (Pharmaceutical / biologic product (product))

UDIEntryType

Codes to identify how UDI data was entered

US Core Condition Category Codes

The US core Condition Category Codes support the separate concepts of problems and health concerns in Condition.category in order for API consumers to be able to separate health concerns and problems. However this is not mandatory for 2015 certification

US Core Procedure Codes

This example value set defines a set of codes that can be used to indicate the type of procedure: a specific code indicating type of procedure performed, from CPT or SNOMED CT.

US Core Substance-Reactant for Intolerance and Negation Codes

A substance or other type of agent (e.g., sunshine) that may be associated with an intolerance reaction event or a propensity to such an event. These concepts are expected to be at a more general level of abstraction (ingredients versus more specific formulations). This value set is quite general and includes concepts that may never cause an adverse event, particularly the included SNOMED CT concepts. The code system-specific value sets in this grouping value set are intended to provide broad coverage of all kinds of agents, but the expectation for use is that the chosen concept identifier for a substance should be appropriately specific and drawn from the available code systems in the following priority order: 1. NDF-RT codes for drug class allergies 2. RxNorm codes limited to term types (TTY) , ‘BN’ Brand Name, ‘IN’ ingredient, ‘MIN’ multiple ingredient, and ‘PIN’ precise ingredient for drug ingredient allergies 3. SNOMED CT including concepts from SCTID 716186003 No Known allergy (situation) and if no other code from above code systems are available

http://fhir.org/guides/argonaut-clinicalnotes/ValueSet/documentreference-category
http://h7.org/fhir/us/core/ValueSet/us-core-medication-codes
http://hl7.org/fhir/ValueSet/adverse-event-actuality
http://hl7.org/fhir/ValueSet/adverse-event-severity
http://hl7.org/fhir/ValueSet/condition-stage-type
http://hl7.org/fhir/ValueSet/coverage-class
http://hl7.org/fhir/ValueSet/coverage-copay-type
http://hl7.org/fhir/ValueSet/device-nametype
http://hl7.org/fhir/ValueSet/device-status-reason
http://hl7.org/fhir/ValueSet/provenance-agent-type
http://hl7.org/fhir/ValueSet/research-study-objective-type
http://hl7.org/fhir/ValueSet/research-study-phase
http://hl7.org/fhir/ValueSet/research-study-prim-purp-type
http://hl7.org/fhir/ValueSet/subscriber-relationship
http://hl7.org/fhir/ValueSet/v2-0092
http://hl7.org/fhir/ValueSet/v2-0131
http://hl7.org/fhir/ValueSet/v2-0276
http://hl7.org/fhir/ValueSet/v2-0371
http://hl7.org/fhir/ValueSet/v2-0487
http://hl7.org/fhir/ValueSet/v2-2.7-0360
http://hl7.org/fhir/ValueSet/v3-ActCode
http://hl7.org/fhir/ValueSet/v3-ActEncounterCode
http://hl7.org/fhir/ValueSet/v3-ActPriority
http://hl7.org/fhir/ValueSet/v3-ConfidentialityClassification
http://hl7.org/fhir/ValueSet/v3-PurposeOfUse
http://hl7.org/fhir/ValueSet/v3-RoleLinkType
http://hl7.org/fhir/ValueSet/v3-ServiceDeliveryLocationRoleType
http://hl7.org/fhir/ValueSet/v3-SubstanceAdminSubstitutionReason
http://hl7.org/fhir/us/core/ValueSet-us-core-substance.html
http://terminology.hl7.org/ValueSet/v2-0116