This page is part of the FHIR Specification (v0.5.0: DSTU 2 Ballot 2). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions
Definition for Value SetFHIRDefinedType
<ValueSet xmlns="http://hl7.org/fhir"> <id value="defined-types"/> <meta> <lastUpdated value="2015-04-03T14:24:32.000+11:00"/> <profile value="http://hl7.org/fhir/StructureDefinition/valueset-shareable-definition"/> </meta> <text> <status value="generated"/> <div xmlns="http://www.w3.org/1999/xhtml"><!-- Snipped for brevity --></div> </text> <extension url="http://hl7.org/fhir/StructureDefinition/valueset-oid"> <valueUri value="urn:oid:2.16.840.1.113883.4.642.2.5"/> </extension> <url value="http://hl7.org/fhir/vs/defined-types"/> <version value="0.5.0"/> <name value="FHIRDefinedType"/> <publisher value="HL7 (FHIR Project)"/> <contact> <telecom> <system value="url"/> <value value="http://hl7.org/fhir"/> </telecom> <telecom> <system value="email"/> <value value="fhir@lists.hl7.org"/> </telecom> </contact> <description value="Either a resource or a data type"/> <status value="draft"/> <experimental value="false"/> <date value="2015-04-03T14:24:32+11:00"/> <define> <extension url="http://hl7.org/fhir/StructureDefinition/valueset-oid"> <valueUri value="urn:oid:2.16.840.1.113883.4.642.1.5"/> </extension> <system value="http://hl7.org/fhir/defined-types"/> <caseSensitive value="true"/> <concept> <code value="Address"/> <definition value="There is a variety of postal address formats defined around the world. This format defines a superset that is the basis for all addresses around the world."/> </concept> <concept> <code value="Age"/> <definition value="A duration (length of time) with a UCUM code"/> </concept> <concept> <code value="Attachment"/> <definition value="For referring to data content defined in other formats."/> </concept> <concept> <code value="BackboneElement"/> <definition value="Base definition for all elements that are defined inside a resource - but not those in a data type."/> </concept> <concept> <code value="CodeableConcept"/> <definition value="A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text."/> </concept> <concept> <code value="Coding"/> <definition value="A reference to a code defined by a terminology system."/> </concept> <concept> <code value="ContactPoint"/> <definition value="Details for All kinds of technology mediated contact points for a person or organization, including telephone, email, etc."/> </concept> <concept> <code value="Count"/> <definition value="A count of a discrete element (no unit)"/> </concept> <concept> <code value="Distance"/> <definition value="A measure of distance"/> </concept> <concept> <code value="Duration"/> <definition value="A length of time"/> </concept> <concept> <code value="Element"/> <definition value="Base definition for all elements in a resource."/> </concept> <concept> <code value="ElementDefinition"/> <definition value="Captures constraints on each element within the resource, profile, or extension."/> </concept> <concept> <code value="Extension"/> <definition value="Optional Extensions Element - found in all resources."/> </concept> <concept> <code value="HumanName"/> <definition value="A human's name with the ability to identify parts and usage."/> </concept> <concept> <code value="Identifier"/> <definition value="A technical identifier - identifies some entity uniquely and unambiguously."/> </concept> <concept> <code value="Meta"/> <definition value="The metadata about a resource. This is content in the resource that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource."/> </concept> <concept> <code value="Money"/> <definition value="An amount of money. With regard to precision, see [[X]]"/> </concept> <concept> <code value="Narrative"/> <definition value="A human-readable formatted text, including images."/> </concept> <concept> <code value="Period"/> <definition value="A time period defined by a start and end date and optionally time."/> </concept> <concept> <code value="Quantity"/> <definition value="A measured amount (or an amount that can potentially be measured). Note that measured amounts include amounts that are not precisely quantified, including amounts involving arbitrary units and floating currencies."/> </concept> <concept> <code value="Range"/> <definition value="A set of ordered Quantities defined by a low and high limit."/> </concept> <concept> <code value="Ratio"/> <definition value="A relationship of two Quantity values - expressed as a numerator and a denominator."/> </concept> <concept> <code value="Reference"/> <definition value="A reference from one resource to another."/> </concept> <concept> <code value="SampledData"/> <definition value="A series of measurements taken by a device, with upper and lower limits. There may be more than one dimension in the data."/> </concept> <concept> <code value="Signature"/> <definition value="An XML digital signature along with supporting context."/> </concept> <concept> <code value="Timing"/> <definition value="Specifies an event that may occur multiple times. Timing schedules are used to record when things are expected or requested to occur. The most common usage is in dosage instructions for medications. They are also used when planning care of various kinds."/> </concept> <concept> <code value="base64Binary"/> <definition value="A stream of bytes"/> </concept> <concept> <code value="boolean"/> <definition value="Value of "true" or "false""/> </concept> <concept> <code value="code"/> <definition value="A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents"/> </concept> <concept> <code value="date"/> <definition value="A date, or partial date (e.g. just year or year + month). There is no time zone. The format is a union of the schema types gYear, gYearMonth and date. Dates SHALL be valid dates."/> </concept> <concept> <code value="dateTime"/> <definition value="A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates."/> </concept> <concept> <code value="decimal"/> <definition value="A rational number with implicit precision"/> </concept> <concept> <code value="id"/> <definition value="Any combination of lowercase letters, numerals, "-" and ".", with a length limit of 36 characters. (This might be an integer, an unprefixed OID, UUID or any other identifier pattern that meets these constraints.) Systems SHALL send ids as lower-case but SHOULD interpret them case-insensitively."/> </concept> <concept> <code value="instant"/> <definition value="An instant in time - known at least to the second"/> </concept> <concept> <code value="integer"/> <definition value="A whole number"/> </concept> <concept> <code value="oid"/> <definition value="An oid represented as a URI"/> </concept> <concept> <code value="positiveInt"/> <definition value="An integer with a value that is positive (e.g. >0)"/> </concept> <concept> <code value="string"/> <definition value="A sequence of Unicode characters"/> </concept> <concept> <code value="time"/> <definition value="A time during the day, with no date specified"/> </concept> <concept> <code value="unsignedInt"/> <definition value="An integer with a value that is not negative (e.g. >= 0)"/> </concept> <concept> <code value="uri"/> <definition value="String of characters used to identify a name or a resource"/> </concept> <concept> <code value="uuid"/> <definition value="A UUID, represented as a URI"/> </concept> <concept> <code value="AllergyIntolerance"/> <definition value="Risk of harmful or undesirable, physiological response which is unique to an individual and associated with exposure to a substance."/> </concept> <concept> <code value="Appointment"/> <definition value="A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s)."/> </concept> <concept> <code value="AppointmentResponse"/> <definition value="A reply to an appointment request for a patient and/or practitioner(s), such as a confirmation or rejection."/> </concept> <concept> <code value="AuditEvent"/> <definition value="A record of an event made for purposes of maintaining a security log. Typical uses include detection of intrusion attempts and monitoring for inappropriate usage."/> </concept> <concept> <code value="Basic"/> <definition value="Basic is used for handling concepts not yet defined in FHIR, narrative-only resources that don't map to an existing resource, and custom resources not appropriate for inclusion in the FHIR specification."/> </concept> <concept> <code value="Binary"/> <definition value="A binary resource can contain any content, whether text, image, pdf, zip archive, etc."/> </concept> <concept> <code value="BodySite"/> <definition value="Record details about the anatomical location of a specimen or body part. This resource may be used when a coded concept does not provide the necessary detail needed for the use case."/> </concept> <concept> <code value="Bundle"/> <definition value="A container for a collection of resources."/> </concept> <concept> <code value="CarePlan"/> <definition value="Describes the intention of how one or more practitioners intend to deliver care for a particular patient for a period of time, possibly limited to care for a specific condition or set of conditions."/> </concept> <concept> <code value="Claim"/> <definition value="A provider issued list of services and products provided, or to be provided, to a patient which is provided to an insurer for payment recovery."/> </concept> <concept> <code value="ClaimResponse"/> <definition value="This resource provides the adjudication details from the processing of a Claim resource."/> </concept> <concept> <code value="ClinicalImpression"/> <definition value="A record of a clinical assessment performed to determine what problem(s) may affect the patient and before planning the treatments or management strategies that are best to manage a patient's condition. Assessments are often 1:1 with a clinical consultation / encounter, but this varies greatly depending on the clinical workflow. This resource is called "ClinicalI mpression" rather than "ClinicalAssessment" to avoid confusion with the recording of assessment tools such as Apgar score."/> </concept> <concept> <code value="Communication"/> <definition value="An occurrence of information being transmitted. E.g., an alert that was sent to a responsible provider, a public health agency was notified about a reportable condition."/> </concept> <concept> <code value="CommunicationRequest"/> <definition value="A request to convey information. E.g., the CDS system proposes that an alert be sent to a responsible provider, the CDS system proposes that the public health agency be notified about a reportable condition."/> </concept> <concept> <code value="Composition"/> <definition value="A set of healthcare-related information that is assembled together into a single logical document that provides a single coherent statement of meaning, establishes its own context and that has clinical attestation with regard to who is making the statement."/> </concept> <concept> <code value="ConceptMap"/> <definition value="A statement of relationships from one set of concepts to one or more other concepts - either code systems or data elements, or classes in class models."/> </concept> <concept> <code value="Condition"/> <definition value="Use to record detailed information about conditions, problems or diagnoses recognized by a clinician. There are many uses including: recording a Diagnosis during an Encounter; populating a problem List or a Summary Statement, such as a Discharge Summary."/> </concept> <concept> <code value="Conformance"/> <definition value="A conformance statement is a set of requirements for a desired implementation or a description of how a target application fulfills those requirements in a particular implementation."/> </concept> <concept> <code value="Contract"/> <definition value="A formal agreement between parties regarding the conduct of business, exchange of information or other matters."/> </concept> <concept> <code value="Contraindication"/> <definition value="Indicates an actual or potential clinical issue with or between one or more active or proposed clinical actions for a patient. E.g. Drug-drug interaction, Ineffective treatment frequency, Procedure-condition conflict, etc."/> </concept> <concept> <code value="Coverage"/> <definition value="Financial instrument which may be used to pay for or reimburse for health care products and services."/> </concept> <concept> <code value="DataElement"/> <definition value="The formal description of a single piece of information that can be gathered and reported."/> </concept> <concept> <code value="Device"/> <definition value="This resource identifies an instance of a manufactured thing that is used in the provision of healthcare without being substantially changed through that activity. The device may be a machine, an insert, a computer, an application, etc. This includes durable (reusable) medical equipment as well as disposable equipment used for diagnostic, treatment, and research for healthcare and public health."/> </concept> <concept> <code value="DeviceComponent"/> <definition value="Describes the characteristics, operational status and capabilities of a medical-related component of a medical device."/> </concept> <concept> <code value="DeviceMetric"/> <definition value="Describes a measurement, calculation or setting capability of a medical device."/> </concept> <concept> <code value="DeviceUseRequest"/> <definition value="Represents a request for a patient to employ a medical device. The device may be an implantable device, or an external assistive device, such as a walker."/> </concept> <concept> <code value="DeviceUseStatement"/> <definition value="A record of a device being used by a patient where the record is the result of a report from the patient or another clinician."/> </concept> <concept> <code value="DiagnosticOrder"/> <definition value="A record of a request for a diagnostic investigation service to be performed."/> </concept> <concept> <code value="DiagnosticReport"/> <definition value="The findings and interpretation of diagnostic tests performed on patients, groups of patients, devices, and locations, and/or specimens derived from these. The report includes clinical context such as requesting and provider information, and some mix of atomic results, images, textual and coded interpretation, and formatted representation of diagnostic reports."/> </concept> <concept> <code value="DocumentManifest"/> <definition value="A manifest that defines a set of documents."/> </concept> <concept> <code value="DocumentReference"/> <definition value="A reference to a document."/> </concept> <concept> <code value="EligibilityRequest"/> <definition value="This resource provides the insurance eligibility details from the insurer regarding a specified coverage and optionally some class of service."/> </concept> <concept> <code value="EligibilityResponse"/> <definition value="This resource provides eligibility and plan details from the processing of an Eligibility resource."/> </concept> <concept> <code value="Encounter"/> <definition value="An interaction between a patient and healthcare provider(s) for the purpose of providing healthcare service(s) or assessing the health status of a patient."/> </concept> <concept> <code value="EnrollmentRequest"/> <definition value="This resource provides the insurance Enrollment details to the insurer regarding a specified coverage."/> </concept> <concept> <code value="EnrollmentResponse"/> <definition value="This resource provides Enrollment and plan details from the processing of an Enrollment resource."/> </concept> <concept> <code value="EpisodeOfCare"/> <definition value="An association between a patient and an organization / healthcare provider(s) during which time encounters may occur. The managing organization assumes a level of responsibility for the patient during this time."/> </concept> <concept> <code value="ExplanationOfBenefit"/> <definition value="This resource provides: the claim details; adjudication details from the processing of a Claim; and optionally account balance information, for informing the subscriber of the benefits provided."/> </concept> <concept> <code value="FamilyMemberHistory"/> <definition value="Significant health events and conditions for a person related to the patient relevant in the context of care for the patient."/> </concept> <concept> <code value="Flag"/> <definition value="Prospective warnings of potential issues when providing care to the patient."/> </concept> <concept> <code value="Goal"/> <definition value="Describes the intended objective(s) of patient care, for example, weight loss, restoring an activity of daily living, etc."/> </concept> <concept> <code value="Group"/> <definition value="Represents a defined collection of entities that may be discussed or acted upon collectively but which are not expected to act collectively and are not formally or legally recognized. I.e. A collection of entities that isn't an Organization."/> </concept> <concept> <code value="HealthcareService"/> <definition value="The details of a Healthcare Service available at a location."/> </concept> <concept> <code value="ImagingObjectSelection"/> <definition value="A set of DICOM SOP Instances of a patient, selected for some application purpose, e.g., quality assurance, teaching, conference, consulting, etc. Objects selected can be from different studies, but must be of the same patient."/> </concept> <concept> <code value="ImagingStudy"/> <definition value="Representation of the content produced in a DICOM imaging study. A study comprises a set of Series, each of which includes a set of Service-Object Pair Instances (SOP Instances - images or other data) acquired or produced in a common context. A Series is of only one modality (e.g., X-ray, CT, MR, ultrasound), but a Study may have multiple Series of different modalities."/> </concept> <concept> <code value="Immunization"/> <definition value="Immunization event information."/> </concept> <concept> <code value="ImmunizationRecommendation"/> <definition value="A patient's point-of-time immunization status and recommendation with optional supporting justification."/> </concept> <concept> <code value="List"/> <definition value="A set of information summarized from a list of other resources."/> </concept> <concept> <code value="Location"/> <definition value="Details and position information for a physical place where services are provided and resources and participants may be stored, found, contained or accommodated."/> </concept> <concept> <code value="Media"/> <definition value="A photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference."/> </concept> <concept> <code value="Medication"/> <definition value="Primarily used for identification and definition of Medication, but also covers ingredients and packaging."/> </concept> <concept> <code value="MedicationAdministration"/> <definition value="Describes the event of a patient consuming or otherwise being administered a medication. This may be as simple as swallowing a tablet or it may be a long running infusion. Related resources tie this event to the authorizing prescription, and the specific encounter between patient and health care practitioner."/> </concept> <concept> <code value="MedicationDispense"/> <definition value="Dispensing a medication to a named patient. This includes a description of the supply provided and the instructions for administering the medication."/> </concept> <concept> <code value="MedicationPrescription"/> <definition value="An order for both supply of the medication and the instructions for administration of the medicine to a patient."/> </concept> <concept> <code value="MedicationStatement"/> <definition value="A record of medication being taken by a patient, or that the medication has been given to a patient where the record is the result of a report from the patient or another clinician."/> </concept> <concept> <code value="MessageHeader"/> <definition value="The header for a message exchange that is either requesting or responding to an action. The Reference(s) that are the subject of the action as well as other Information related to the action are typically transmitted in a bundle in which the MessageHeader resource instance is the first resource in the bundle."/> </concept> <concept> <code value="NamingSystem"/> <definition value="A curated namespace that issues unique symbols within that namespace for the identification of concepts, people, devices, etc. Represents a "System" used within the Identifier and Coding data types."/> </concept> <concept> <code value="NutritionOrder"/> <definition value="A request to supply a diet, formula feeding (enteral) or oral nutritional supplement to a patient/resident."/> </concept> <concept> <code value="Observation"/> <definition value="Measurements and simple assertions made about a patient, device or other subject."/> </concept> <concept> <code value="OperationDefinition"/> <definition value="A formal computable definition of an operation (on the RESTful interface) or a named query (using the search interaction)."/> </concept> <concept> <code value="OperationOutcome"/> <definition value="A collection of error, warning or information messages that result from a system action."/> </concept> <concept> <code value="Order"/> <definition value="A request to perform an action."/> </concept> <concept> <code value="OrderResponse"/> <definition value="A response to an order."/> </concept> <concept> <code value="Organization"/> <definition value="A formally or informally recognized grouping of people or organizations formed for the purpose of achieving some form of collective action. Includes companies, institutions, corporations, departments, community groups, healthcare practice groups, etc."/> </concept> <concept> <code value="Patient"/> <definition value="Demographics and other administrative information about an individual or animal receiving care or other health-related services."/> </concept> <concept> <code value="PaymentNotice"/> <definition value="This resource provides the status of the payment for goods and services rendered, and the request and response resource references."/> </concept> <concept> <code value="PaymentReconciliation"/> <definition value="This resource provides payment details and claim references supporting a bulk payment."/> </concept> <concept> <code value="Person"/> <definition value="Demographics and administrative information about a person independent of a specific health-related context."/> </concept> <concept> <code value="Practitioner"/> <definition value="A person who is directly or indirectly involved in the provisioning of healthcare."/> </concept> <concept> <code value="Procedure"/> <definition value="An action that is or was performed on a patient. This can be a physical 'thing' like an operation, or less invasive like counseling or hypnotherapy."/> </concept> <concept> <code value="ProcedureRequest"/> <definition value="A request for a procedure to be performed. May be a proposal or an order."/> </concept> <concept> <code value="ProcessRequest"/> <definition value="This resource provides the target, request and response, and action details for an action to be performed by the target on or about existing resources."/> </concept> <concept> <code value="ProcessResponse"/> <definition value="This resource provides processing status, errors and notes from the processing of a resource."/> </concept> <concept> <code value="Provenance"/> <definition value="Provenance of a resource is a record that describes entities and processes involved in producing and delivering or otherwise influencing that resource. Provenance provides a critical foundation for assessing authenticity, enabling trust, and allowing reproducibility. Provenance assertions are a form of contextual metadata and can themselves become important records with their own provenance. Provenance statement indicates clinical significance in terms of confidence in authenticity, reliability, and trustworthiness, integrity, and stage in lifecycle (e.g., Document Completion - has the artifact been legally authenticated), all of which may impact Security, Privacy, and Trust policies."/> </concept> <concept> <code value="Questionnaire"/> <definition value="A structured set of questions intended to guide the collection of answers. The questions are ordered and grouped into coherent subsets, corresponding to the structure of the grouping of the underlying questions."/> </concept> <concept> <code value="QuestionnaireAnswers"/> <definition value="A structured set of questions and their answers. The questions are ordered and grouped into coherent subsets, corresponding to the structure of the grouping of the underlying questions."/> </concept> <concept> <code value="ReferralRequest"/> <definition value="Used to record and send details about a request for referral service or transfer of a patient to the care of another provider or provider organisation."/> </concept> <concept> <code value="RelatedPerson"/> <definition value="Information about a person that is involved in the care for a patient, but who is not the target of healthcare, nor has a formal responsibility in the care process."/> </concept> <concept> <code value="RiskAssessment"/> <definition value="An assessment of the likely outcome(s) for a patient or other subject as well as the likelihood of each outcome."/> </concept> <concept> <code value="Schedule"/> <definition value="A container for slot(s) of time that may be available for booking appointments."/> </concept> <concept> <code value="SearchParameter"/> <definition value="A Search Parameter that defines a named search item that can be used to search/filter on a resource."/> </concept> <concept> <code value="Slot"/> <definition value="A slot of time on a schedule that may be available for booking appointments."/> </concept> <concept> <code value="Specimen"/> <definition value="Sample for analysis."/> </concept> <concept> <code value="StructureDefinition"/> <definition value="A definition of a FHIR structure. This resource is used to describe the underlying resources, data types defined in FHIR, and also for describing extensions, and constraints on resources and data types."/> </concept> <concept> <code value="Subscription"/> <definition value="The subscription resource is used to define a push based subscription from a server to another system. Once a subscription is registered with the server, the server checks every resource that is created or updated, and if the resource matches the given criteria, it sends a message on the defined "channel" so that another system is able to take an appropriate action."/> </concept> <concept> <code value="Substance"/> <definition value="A homogeneous material with a definite composition."/> </concept> <concept> <code value="Supply"/> <definition value="A supply - a request for something, and provision of what is supplied."/> </concept> <concept> <code value="ValueSet"/> <definition value="A value set specifies a set of codes drawn from one or more code systems."/> </concept> <concept> <code value="VisionPrescription"/> <definition value="An authorization for the supply of glasses and/or contact lenses to a patient."/> </concept> </define> </ValueSet>
Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.