2nd DSTU Draft For Comment
This page is part of the FHIR Specification (v0.4.0: DSTU 2 Draft). 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
{
"resourceType": "ValueSet",
"id": "defined-types",
"meta": {
"lastUpdated": "2015-02-23T09:07:27.665+11:00",
"profile": [
"http://hl7.org/fhir/Profile/valueset-shareable-definition"
]
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"extension": [
{
"url": "http://hl7.org/fhir/ExtensionDefinition/valueset-oid",
"valueUri": "urn:oid:2.16.840.1.113883.4.642.2.5"
}
],
"url": "http://hl7.org/fhir/vs/defined-types",
"version": "0.4.0",
"name": "FHIRDefinedType",
"publisher": "HL7 (FHIR Project)",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://hl7.org/fhir"
},
{
"system": "email",
"value": "fhir@lists.hl7.org"
}
]
}
],
"description": "Either a resource or a data type",
"status": "draft",
"experimental": false,
"date": "2015-02-23T09:07:27+11:00",
"define": {
"extension": [
{
"url": "http://hl7.org/fhir/ExtensionDefinition/valueset-oid",
"valueUri": "urn:oid:2.16.840.1.113883.4.642.1.5"
}
],
"system": "http://hl7.org/fhir/defined-types",
"caseSensitive": true,
"concept": [
{
"code": "Address",
"definition": "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."
},
{
"code": "Age",
"definition": "A duration (length of time) with a UCUM code"
},
{
"code": "Attachment",
"definition": "For referring to data content defined in other formats."
},
{
"code": "BackboneElement",
"definition": "Base definition for all elements that are defined inside a resource - but not those in a data type."
},
{
"code": "CodeableConcept",
"definition": "A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text."
},
{
"code": "Coding",
"definition": "A reference to a code defined by a terminology system."
},
{
"code": "ContactPoint",
"definition": "Details for All kinds of technology mediated contact points for a person or organization, including telephone, email, etc."
},
{
"code": "Count",
"definition": "A count of a discrete element (no unit)"
},
{
"code": "Distance",
"definition": "A measure of distance"
},
{
"code": "Duration",
"definition": "A length of time"
},
{
"code": "Element",
"definition": "Base definition for all elements in a resource."
},
{
"code": "ElementDefinition",
"definition": "Captures constraints on each element within the resource, profile, or extension."
},
{
"code": "Extension",
"definition": "Optional Extensions Element - found in all resources."
},
{
"code": "HumanName",
"definition": "A human's name with the ability to identify parts and usage."
},
{
"code": "Identifier",
"definition": "A technical identifier - identifies some entity uniquely and unambiguously."
},
{
"code": "Meta",
"definition": "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."
},
{
"code": "Money",
"definition": "An amount of money. With regard to precision, see [[X]]"
},
{
"code": "Narrative",
"definition": "A human-readable formatted text, including images."
},
{
"code": "Period",
"definition": "A time period defined by a start and end date and optionally time."
},
{
"code": "Quantity",
"definition": "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."
},
{
"code": "Range",
"definition": "A set of ordered Quantities defined by a low and high limit."
},
{
"code": "Ratio",
"definition": "A relationship of two Quantity values - expressed as a numerator and a denominator."
},
{
"code": "Reference",
"definition": "A reference from one resource to another."
},
{
"code": "SampledData",
"definition": "A series of measurements taken by a device, with upper and lower limits. There may be more than one dimension in the data."
},
{
"code": "Signature",
"definition": "An XML digital signature along with supporting context."
},
{
"code": "Timing",
"definition": "Specifies an event that may occur multiple times. Timing schedules are used for to record when things are expected or requested to occur."
},
{
"code": "base64Binary",
"definition": "A stream of bytes"
},
{
"code": "boolean",
"definition": "Value of \"true\" or \"false\""
},
{
"code": "code",
"definition": "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"
},
{
"code": "date",
"definition": "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."
},
{
"code": "dateTime",
"definition": "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 may be provided but may also be ignored. Dates SHALL be valid dates."
},
{
"code": "decimal",
"definition": "A rational number with implicit precision"
},
{
"code": "id",
"definition": "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."
},
{
"code": "instant",
"definition": "An instant in time - known at least to the second"
},
{
"code": "integer",
"definition": "A whole number"
},
{
"code": "oid",
"definition": "An oid represented as a URI"
},
{
"code": "string",
"definition": "A sequence of Unicode characters"
},
{
"code": "time",
"definition": "A time during the day, with no date specified"
},
{
"code": "uri",
"definition": "String of characters used to identify a name or a resource"
},
{
"code": "uuid",
"definition": "A UUID, represented as a URI"
},
{
"code": "Alert",
"definition": "Prospective warnings of potential issues when providing care to the patient."
},
{
"code": "AllergyIntolerance",
"definition": "Risk of harmful or undesirable, physiological response which is unique to an individual and associated with exposure to a substance."
},
{
"code": "Appointment",
"definition": "A scheduled healthcare event for a patient and/or practitioner(s) where a service may take place at a specific date/time."
},
{
"code": "AppointmentResponse",
"definition": "A reply to an appointment request for a patient and/or practitioner(s), such as a confirmation or rejection."
},
{
"code": "Basic",
"definition": "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."
},
{
"code": "Binary",
"definition": "A binary resource can contain any content, whether text, image, pdf, zip archive, etc."
},
{
"code": "BodySite",
"definition": "Record details about the anatomical location of a specimen or body part, including precise localisation information. This resource may be used when a coded concept does not provide the necessary detail needed for the use case."
},
{
"code": "Bundle",
"definition": "A container for a group of resources."
},
{
"code": "CarePlan",
"definition": "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."
},
{
"code": "CarePlan2",
"definition": "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."
},
{
"code": "ClaimResponse",
"definition": "This resource provides the adjudication details from the processing of a Claim resource."
},
{
"code": "ClinicalAssessment",
"definition": "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."
},
{
"code": "Communication",
"definition": "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."
},
{
"code": "CommunicationRequest",
"definition": "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."
},
{
"code": "Composition",
"definition": "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."
},
{
"code": "ConceptMap",
"definition": "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."
},
{
"code": "Condition",
"definition": "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."
},
{
"code": "Conformance",
"definition": "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."
},
{
"code": "Contract",
"definition": "A formal agreement between parties regarding the conduct of business, exchange of information or other matters."
},
{
"code": "Contraindication",
"definition": "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."
},
{
"code": "Coverage",
"definition": "Financial instrument which may be used to pay for or reimburse for health care products and services."
},
{
"code": "DataElement",
"definition": "The formal description of a single piece of information that can be gathered and reported."
},
{
"code": "Device",
"definition": "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."
},
{
"code": "DeviceComponent",
"definition": "Describes the characteristics, operational status and capabilities of a medical-related component of a medical device."
},
{
"code": "DeviceMetric",
"definition": "Describes a measurement, calculation or setting capability of a medical device."
},
{
"code": "DeviceUseRequest",
"definition": "Represents a request for the use of a device."
},
{
"code": "DeviceUseStatement",
"definition": "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."
},
{
"code": "DiagnosticOrder",
"definition": "A record of a request for a diagnostic investigation service to be performed."
},
{
"code": "DiagnosticReport",
"definition": "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."
},
{
"code": "DocumentManifest",
"definition": "A manifest that defines a set of documents."
},
{
"code": "DocumentReference",
"definition": "A reference to a document."
},
{
"code": "EligibilityRequest",
"definition": "This resource provides the insurance eligibility details from the insurer regarding a specified coverage and optionally some class of service."
},
{
"code": "EligibilityResponse",
"definition": "This resource provides eligibility and plan details from the processing of an Eligibility resource."
},
{
"code": "Encounter",
"definition": "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."
},
{
"code": "EnrollmentRequest",
"definition": "This resource provides the insurance Enrollment details to the insurer regarding a specified coverage."
},
{
"code": "EnrollmentResponse",
"definition": "This resource provides Enrollment and plan details from the processing of an Enrollment resource."
},
{
"code": "EpisodeOfCare",
"definition": "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."
},
{
"code": "ExplanationOfBenefit",
"definition": "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."
},
{
"code": "ExtensionDefinition",
"definition": "Defines an extension that can be used in resources."
},
{
"code": "FamilyHistory",
"definition": "Significant health events and conditions for people related to the subject relevant in the context of care for the subject."
},
{
"code": "Goal",
"definition": "Describes the intended objective(s) of the care."
},
{
"code": "Group",
"definition": "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."
},
{
"code": "HealthcareService",
"definition": "The details of a Healthcare Service available at a location."
},
{
"code": "ImagingObjectSelection",
"definition": "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."
},
{
"code": "ImagingStudy",
"definition": "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."
},
{
"code": "Immunization",
"definition": "Immunization event information."
},
{
"code": "ImmunizationRecommendation",
"definition": "A patient's point-of-time immunization status and recommendation with optional supporting justification."
},
{
"code": "InstitutionalClaim",
"definition": "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."
},
{
"code": "List",
"definition": "A set of information summarized from a list of other resources."
},
{
"code": "Location",
"definition": "Details and position information for a physical place where services are provided and resources and participants may be stored, found, contained or accommodated."
},
{
"code": "Media",
"definition": "A photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference."
},
{
"code": "Medication",
"definition": "Primarily used for identification and definition of Medication, but also covers ingredients and packaging."
},
{
"code": "MedicationAdministration",
"definition": "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.\r\rRelated resources tie this event to the authorizing prescription, and the specific encounter between patient and health care practitioner."
},
{
"code": "MedicationDispense",
"definition": "Dispensing a medication to a named patient. This includes a description of the supply provided and the instructions for administering the medication."
},
{
"code": "MedicationPrescription",
"definition": "An order for both supply of the medication and the instructions for administration of the medicine to a patient."
},
{
"code": "MedicationStatement",
"definition": "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."
},
{
"code": "MessageHeader",
"definition": "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."
},
{
"code": "NamingSystem",
"definition": "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."
},
{
"code": "NutritionOrder",
"definition": "A request to supply a diet, formula feeding (enteral) or oral nutritional supplement to a patient/resident."
},
{
"code": "Observation",
"definition": "Measurements and simple assertions made about a patient, device or other subject."
},
{
"code": "OperationDefinition",
"definition": "A formal computable definition of an operation (on the RESTful interface) or a named query (using the search interaction)."
},
{
"code": "OperationOutcome",
"definition": "A collection of error, warning or information messages that result from a system action."
},
{
"code": "OralHealthClaim",
"definition": "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."
},
{
"code": "Order",
"definition": "A request to perform an action."
},
{
"code": "OrderResponse",
"definition": "A response to an order."
},
{
"code": "Organization",
"definition": "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."
},
{
"code": "Other",
"definition": "Other is a conformant for handling resource concepts not yet defined for FHIR or outside HL7's scope of interest."
},
{
"code": "Patient",
"definition": "Demographics and other administrative information about a person or animal receiving care or other health-related services."
},
{
"code": "PaymentNotice",
"definition": "This resource provides the status of the payment for goods and services rendered, and the request and response resource references."
},
{
"code": "PaymentReconciliation",
"definition": "This resource provides payment details and claim references supporting a bulk payment."
},
{
"code": "PendedRequest",
"definition": "This resource provides the request and response details for the resource for which the status is to be checked."
},
{
"code": "Person",
"definition": "Demographics and administrative information about a person independent of a specific health-related context."
},
{
"code": "PharmacyClaim",
"definition": "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."
},
{
"code": "Practitioner",
"definition": "A person who is directly or indirectly involved in the provisioning of healthcare."
},
{
"code": "Procedure",
"definition": "An action that is performed on a patient. This can be a physical 'thing' like an operation, or less invasive like counseling or hypnotherapy."
},
{
"code": "ProcedureRequest",
"definition": "A request for a procedure to be performed. May be a proposal or an order."
},
{
"code": "ProfessionalClaim",
"definition": "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."
},
{
"code": "Profile",
"definition": "A Resource Profile - a statement of use of one or more FHIR Resources. It may include constraints on Resources and Data Types, Terminology Binding Statements and Extension Definitions."
},
{
"code": "Provenance",
"definition": "Provenance information that describes the activity that led to the creation of a set of resources. This information can be used to help determine their reliability or trace where the information in them came from. The focus of the provenance resource is record keeping, audit and traceability, and not explicit statements of clinical significance."
},
{
"code": "Questionnaire",
"definition": "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."
},
{
"code": "QuestionnaireAnswers",
"definition": "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."
},
{
"code": "Readjudicate",
"definition": "This resource provides the request and line items details for the claim which is to be re-adjudicated."
},
{
"code": "ReferralRequest",
"definition": "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."
},
{
"code": "RelatedPerson",
"definition": "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."
},
{
"code": "Reversal",
"definition": "This resource provides the request and response details for the request for which all actions are to be reversed or terminated."
},
{
"code": "RiskAssessment",
"definition": "An assessment of the likely outcome(s) for a patient or other subject as well as the likelihood of each outcome."
},
{
"code": "Schedule",
"definition": "A container for slot(s) of time that may be available for booking appointments."
},
{
"code": "SearchParameter",
"definition": "A Search Parameter that defines a named search item that can be used to search/filter on a resource."
},
{
"code": "SecurityEvent",
"definition": "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."
},
{
"code": "Slot",
"definition": "A slot of time on a schedule that may be available for booking appointments."
},
{
"code": "Specimen",
"definition": "Sample for analysis."
},
{
"code": "StatusRequest",
"definition": "This resource provides the request and response details for the resource for which the processing status is to be checked."
},
{
"code": "StatusResponse",
"definition": "This resource provides processing status, errors and notes from the processing of a resource."
},
{
"code": "StructureDefinition",
"definition": "A Resource Profile - a statement of use of one or more FHIR Resources. It may include constraints on Resources and Data Types, Terminology Binding Statements and Extension Definitions."
},
{
"code": "Subscription",
"definition": "Todo."
},
{
"code": "Substance",
"definition": "A homogeneous material with a definite composition."
},
{
"code": "Supply",
"definition": "A supply - a request for something, and provision of what is supplied."
},
{
"code": "SupportingDocumentation",
"definition": "This resource provides the supporting information for a process, for example clinical or financial information related to a claim or pre-authorization."
},
{
"code": "ValueSet",
"definition": "A value set specifies a set of codes drawn from one or more code systems."
},
{
"code": "VisionClaim",
"definition": "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."
},
{
"code": "VisionPrescription",
"definition": "An authorization for the supply of glasses and/or contact lenses to a patient."
}
]
}
}
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.
© HL7.org 2011+. FHIR DSTU (v0.4.0-4167) generated on Mon, Feb 23, 2015 09:09+1100.
Links: What's a DSTU? |
Version History |
Compare to DSTU1 |
|
Propose a change