HL7 Conformance Conformance 1 1 Mandatory false A conformance statement returned by request in an RESTful framework Conformance.id 1 1 Mandatory id false Globally unique Conformance Statement Id (Must be a UUID) Conformance.date 1 1 Mandatory dateTime false Date that the conformance statement is published Conformance.publisher 1 1 Mandatory false The organization that publishes this conformance statement Conformance.publisher.name 1 1 Mandatory string false Name of Organization Conformance.publisher.address 0 unbounded Optional Address false Address of Organization Conformance.publisher.contact 0 unbounded Optional Contact false Contacts for Organization Conformance.software 1 1 Mandatory false The software that is covered by this conformance statement Conformance.software.name 1 1 Mandatory string false Name software is known by Conformance.software.version 1 1 Mandatory string false Version covered by this statement Conformance.software.releaseDate 0 1 Optional dateTime false Date this version released Conformance.mode 1 1 Mandatory code RestfulConformanceMode false client | server Conformance.profile 0 unbounded Optional uri false Additional other profiles that apply to this conformance statement. Generally these profiles make constraints on the bindings of concept domains / value sets Conformance.resource 1 1 Mandatory Constraint ResourceType false Resource Type with constraints Conformance.operation 0 1 Conditional A resource type is required if the event declaration has multiple focal resources false Conformance.operation.read 0 1 Optional boolean false if supported Conformance.operation.vread 0 1 Optional boolean false if supported Conformance.operation.update 0 1 Optional boolean false if supported Conformance.operation.delete 0 1 Optional boolean false if supported Conformance.operation.validate 0 1 Optional boolean false if supported Conformance.operation.history 0 1 Optional boolean false if supported Conformance.operation.transaction 0 1 Optional false only if supported Conformance.operation.transaction.name 1 unbounded Mandatory code false transaction names supported Conformance.operation.search 0 1 Optional false only if supported Conformance.operation.search.param 1 unbounded Mandatory string false search params supported Conformance.operation.create 0 1 Optional false if supported Conformance.operation.create.id 1 1 Mandatory code ResourceIdSource false source of id: client | server | either Conformance.operation.updates 0 1 Optional boolean false if supported Conformance.operation.updates.param 0 unbounded Mandatory string false update filter params supported Conformance.operation.schema 0 1 Optional boolean false if supported Conformance.extensions 0 1 Optional false See Extensions Conformance.text 1 1 Mandatory Narrative false Text summary of conformance profile for human interpretation Document Document 1 1 Mandatory true A documentation of clinical observations and services that are aggregated together into a single statement of clinical meaning that establishes it's own context. A clinical document is composed of a set of resources that include both human and computer readable portions. A human must attest to the accuracy of the human readable portion, and may authenticate and/or sign the entire whole For document based framework Confidentiality? Language? Consent? Signatures Document.id 1 1 Mandatory id true the unique id of a clinical document Each document needs a unique identifier so other documents and underlying infrastructure can reference it must be globally unique. UUIDs are recommended Document.instant 1 1 Mandatory instant true the document creation time, when the document first came into being. Where the CDA document is a transform from an original document in some other format, the ClinicalDocument.effectiveTime is the time the original document is created. Document.type 1 1 Mandatory CodeableConcept DocumentType true specifying the particular kind of document (e.g. History and Physical, Discharge Summary, Progress Note) Document.title 0 1 Optional string false the title of the document It's commonly the case that clinical documents do not have a title, and are collectively referred to by the display name of Document.type (e.g. a "consultation" or "progress note"). Where these display names are rendered to the clinician, or where the document has a unique title, the Document.title value should be used Document.setId 0 1 Conditional cannot have both setId and replaces id true Represents an identifier that is common across all document revisions Document.version 0 1 Optional integer true used to version successive replacement documents An integer value is recommended Document.replaces 0 1 Conditional cannot have both setId and replaces id true If this document replaces another Document.subject 1 1 Mandatory Resource(Patient|Group) true who the document is about Document.author 1 unbounded Mandatory false Author (contributed content to document) Document.author.time 0 1 Optional dateTime false When authoring happened Document.author.party 1 1 Mandatory Resource(Person|Device) false who/what authored the final document Document.attestor 0 unbounded Optional false a participant who has attested to the accuracy of the document Document.attestor.mode 1 1 Mandatory code DocumentAuthenticationMode false The type of attestation the authenticator offers Document.attestor.time 0 1 Optional dateTime false When document attested Document.attestor.party 0 1 Optional Resource(Person|Organisation) false who attested the document Document.recipient 0 unbounded Optional Resource(Person|Organization) false expected to receive a copy Document.custodian 1 1 Mandatory Resource(Organization) false org which maintains the document. Document.event 0 1 Optional Resource(Any) false the main Act, such as a colonoscopy or an appendectomy, being documented The event needs to be consistent with the type element, though can provide further information if desired Document.encounter 0 1 Optional Resource(Admission|InterestOfCare) false context of the document Document.section 1 unbounded Mandatory false Document is broken into sections Document.section.type 0 1 Optional CodeableConcept DocumentSectionType false type of section (recommended) Document.section.instant 0 1 Optional instant false the section creation time (sections are often re-used in several documents). Document.section.author 0 1 Optional false if section author different to document Document.section.author.time 0 1 Optional dateTime false When authoring happened Document.section.author.party 1 1 Mandatory Resource(Person|Device) false who/what authored the section Document.section.enterer 0 1 Optional Resource(Person|Device) false The person or device that performed the data entry leading to this section. Where there is more than one candidate, pick the most proximal to the message. Can provide other enterers in extensions Document.section.subject 0 1 Optional Resource(Person|Group) true if section different to document Document.section.informant 0 1 Optional Resource(Person) false provided information in section Document.section.content 0 1 Conditional a section must have content or one or more sections Resource(Any) true the actual content of the section Document.section.section 0 unbounded Conditional a section must have content or one or more sections false nested Section Document.section.section.# 1 1 Mandatory @Document.Section false contents as for a section Document.extensions 0 1 Optional false See Extensions Document.text 1 1 Mandatory Narrative false Message Message 1 1 Mandatory false A message that contains FHIR resources Many implementations are not prepared to use REST, and need a message based infrastructure Message.id 1 1 Mandatory id true Unique Id for this message Each message needs a unique identifier so other messages and underlying infrastructure can reference it must be unique within a channel, but should be globally unique. UUIDs are recommended Message.threadId 0 1 Optional id false Id of the thread - a series of messages that pertain to the same logical sequence, and are all identified by the same thread identifier Message.instant 1 1 Mandatory instant true Instant the message was sent Message.event 1 1 Mandatory code MessageEvent true Code that identifies the event this message represents, and connects it with the event definition in the FHIR specification Message.response 0 1 Optional true Information about the the message that this message is a response to - if it is a response Message.response.id 1 1 Mandatory id true The id of the message that this a response to this message must have the same threadId as the original message (including missing if the original message threadId was missing) Message.response.code 1 1 Mandatory code ResponseCode true Code that identifies the type of response to the message - whether it was successful or not, and whether it should be resent or not This is a generic response to the request message. Specific data for the response will be found in Message.data Message.response.duplicate 1 1 Mandatory boolean true True if this is not the first response, because the request message has been received more than once The request shouldn't be received more than once if reliable message delivery applies, but mostly it doesn't Message.source 1 1 Mandatory Resource(Device) false The source application from which this message originated Message.destination 1 1 Mandatory Resource(Device) false The destination application which the message is intended for Message.enterer 0 1 Optional Resource(Person|Device) false The person or device that performd the data entry leading to this message. Where there is more than one candidate, pick the most proximal to the message. Can provide other enterers in extensions Need to know for audit/traceback requirements Usually only for the request, but can be used in a response Message.author 0 1 Optional Resource(Person|Device) false The logical author of the message - the person or device that decided it should happen. Where there is more than one candidate, pick the most proximal to the message. Can provide other enterers in extensions Need to know for audit/traceback requirements Usually only for the request, but can be used in a response Message.responsible 0 1 Optional Resource(Person|Organization) false The person or organization that accepts overall responsbility for the contents of the message. The implication is that the message event happened under the policies of the responsible party Need to know for audit/traceback requirements Usually only for the request, but can be used in a response Message.effective 0 1 Optional Interval(dateTime) false The effective time - the real world time of the even that the message represents. Usually this is just a starting time, but some message events also have an end time (do x for period y) Need to know for understanding the content of the message Usually only for the request, but can be used in a response Grahame thinks this is not 80/20. Also, that it reall should be domain modeled, not tucked away here Message.reason 0 1 Optional CodeableConcept EventReason false The cause of the event - a reason for why this message is being sent Need to be able to track why resources are being changed and report in the audit log / history of the resource ControlAct.reasonCode Message.data 0 1 Conditional Mandatory unless the message is a response, in which case the element is optional Resource(Any) true The actual data of the message - a reference to the focus class of the message. Every message event is about actual data, a single resource, that is identified in the definition of the event, and perhaps some or all linked resources The data is defined where the transaction type is defined. The transaction data is always aggregated with the transaction resource Message.extensions 0 1 Optional false See Extensions Message.text 1 1 Mandatory Narrative false Animal Animal 1 1 Mandatory false An animal that has relevance to the care process -usually this is for animals that are patients. Need to be able to track animals - vetinary medicine is an active user of HL7 standards Animals differ because you need to track species and strain, and also different kind of relationships - owners NonPersonLivingSubject(classCode=ANM, determinerCode=INST) Animal.id 1 1 Mandatory id false Master Resource Id, always first in all resources .id(scope=OBJ) Animal.identifier 0 unbounded HumanId true Identifier for the animal that is used to identify the person across multiple disparate systems and also for face to face identification of the person Animals are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the animal .scopes[Role](classCode=IDENT) Animal.name 0 unbounded HumanName true A name associated with the animal. The use code maiden does not apply. Some animals have names, which are assigned by humans for human reasons, and follow human naming patterns .name Animal.dob 0 1 Optional dateTime true The birth date for the animal Age of the animal drives many clinical processes. .dateOfBirth RIM change to support human date (time only - but is this needed in this context?) Animal.species 0 1 Optional CodeableConcept AnimalSpecies true Species for the animal Need to know what kind of animal .code Animal.strain 0 1 Optional CodeableConcept AnimalStrain true Strain for the animal May need to know the specific kind within the species .strainText Not sure why this is ED in the RIM. Should probably change to SC. Animal.gender 0 1 Optional CodeableConcept AnimalGender true Gender for the Animal For managing the animal Note that some animals have additional gender not encountered in humans? .administrativeGenderCode Animal.relatedEntity 0 unbounded false Kin, owner, care giver etc Animal.relatedEntity.id 0 1 Optional HumanId false Identifier for the entity Animal.relatedEntity.role 1 1 Mandatory CodeableConcept AnimalRelationship false Type of relationship Animal.relatedEntity.name 0 1 Optional HumanName false Name of the related entity Animal.relatedEntity.address 0 unbounded Address false An address (usually human, but may be kin) Animal.relatedEntity.contact 0 unbounded Contact false Contact details (usually for humans) Animal.extensions 0 1 Optional false See Extensions [varies] Animal.text 1 1 Mandatory Narrative false .text Agent Agent 1 1 Mandatory false A person who represents an organisation, and is authorised to perform actions on it's behalf Need to track doctors, staff, locums etc for both healthcare providers, funders, etc. Role PRD (as one example) Agent.id 1 1 Mandatory id false Master Resource Id, always first in all resources .id(scope=OBJ) Agent.person 1 1 Mandatory Resource(Person) true The person who acts as the agent Need to be able to track the person who represents the organisation separately PRD-2 Agent.organization 1 1 Mandatory Resource(Organization) true The organisation that is being represented Need to be able to track the represented organisation separately PRD-10 (-> 14) Agent.role 1 unbounded Mandatory CodeableConcept AgentRole true The way in which the person represents the organisation - what role do they have? Need to know what authority the agent has - what can they do? A person may have more than one role. At least one role is required - why have an agent who isn't actually an agent? PRD-1 Agent.period 0 1 Optional Interval(date) false The time period during which the agent was/is authorised to represent the organisation. Agencies are often for a limited period of time, and can be revoked. Even after the agencies is revoked, the fact that it existed must still be recorded PRD-8/9 Agent.identifier 0 unbounded HumanId true An identifier that applies to this person in this role Often, specific identifies are assigned for the agent The identifier changes when a new/different person steps into the same role PRD-7 Agent.address 0 unbounded Address false A postal address for this person playing this role i.e. the address is not their personal address. For many agents, this is the same as their work address PRD-3 What about place? (PRD-4) Agent.contact 0 unbounded Contact false A contact detail address for this person playing this role i.e. the contact is not their personal contact. For many agents, this is the same as their work contacts. Note that a person may choose to use a personal mobile phone (for instance) for their contact in a given role - in this case, the contact detail will be repeated in the agent resource PRD-5 Agent.extensions 0 1 Optional false See Extensions Agent.text 1 1 Mandatory Narrative false Text summary of the agent, for human interpretation MessageConformance MessageConformance 1 1 Mandatory false A conformance statement about how an application uses FHIR messaging MessageConformance.id 1 1 Mandatory id false Globally unique Conformance Statement Id (Must be a UUID) MessageConformance.date 1 1 Mandatory dateTime false Date that the conformance statement is published MessageConformance.publisher 1 1 Mandatory false The organization that publishes this conformance statement MessageConformance.publisher.name 1 1 Mandatory string false Name of Organization MessageConformance.publisher.address 0 unbounded Optional Address false Address of Organization MessageConformance.publisher.contact 0 unbounded Optional Contact false Contacts for Organization MessageConformance.software 1 1 Mandatory false The software that is covered by this conformance statement MessageConformance.software.name 1 1 Mandatory string false Name software is known by MessageConformance.software.version 1 1 Mandatory string false Version covered by this statement MessageConformance.software.releaseDate 0 1 Optional dateTime false Date this version released MessageConformance.profile 0 unbounded Optional uri false Additional other profiles that apply to this conformance statement. Generally these profiles make constraints on the bindings of concept domains / value sets MessageConformance.event 1 unbounded Mandatory false An event supported by the application MessageConformance.event.code 1 1 Mandatory code MessageEvent false The code for the event MessageConformance.event.resource 0 1 Conditional A resource type is required if the event declaration has multiple focal resources code ResourceType false The focal resource for the event MessageConformance.event.mode 1 1 Mandatory code MessageConformanceEventMode false The mode of this event declaration - whether application is sender or receiver MessageConformance.event.request 0 1 Optional false Information about the request for this event MessageConformance.event.request.resource 1 unbounded Mandatory Constraint false Constraint on a resource used in the event request MessageConformance.event.response 0 1 Optional false Information about the response for this event MessageConformance.event.response.resource 1 unbounded Mandatory Constraint false Constraint on a resource used in the event response MessageConformance.extensions 0 1 Optional false See Extensions MessageConformance.text 1 1 Mandatory Narrative false Organization Organization 1 1 Mandatory false For any organization/institution/government department that has relevance to the care process Organization(classCode=ORG, determinerCode=INST) Organization.id 1 1 Mandatory id false Master Resource Id, always first in all resources .id(scope=OBJ) Organization.identifier 0 unbounded HumanId true Identifier for the organization that is used to identify the organization across multiple disparate systems Organizations are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the organization. .scopes[Role](classCode=IDENT) Organization.name 0 unbounded true A name associated with the organization Need to use the name as the label of the organization Don't use HumanName since that has many non-organization things in it .name Organization.name.value 1 1 Mandatory string true The actual name of the organization .part[1](type=NULL,qualifier=NULL).value Organization.name.period 0 1 Optional Interval(date) false The period that this name was in use by the organization Organizations have a habit of renaming themselves, and the current and past names are required .validTime This is 80%?? Organization.address 0 unbounded Address false An address for the organization May need to keep track of the organizations addresses for contacting, billing or reporting requirements Organization may have multiple addresses with different uses or applicable periods. The use code home is not to be used .address Organization.contact 0 unbounded Contact false A contact detail for the organization Human contact for the organization The use code home is not to be used. Note that these contacts are not the contact details of people who are employed by or represent the organization, but official contacts for the organization itself .telecom Organization.code 0 1 Optional CodeableConcept OrganisationType false The kind of organization that this is Need to be able to track the kind of organization that this is - different organization types have different uses Organizations can be corporations, wards, sections, clinical teams, government departments, etc. Note that code is generally a classifier of the type of organization; in many applications, codes are used to identity a particular organization (say, ward) as opposed to another of the same type - these are identifiers, not codes .code Name code is too RIM-like. Should be typeCode or type. Organization.industryCode 0 1 Optional CodeableConcept Industry false The industry that this organization is involved in For some organization types, an industry code is required for statistical reporting requirements .standardIndustryClassCode Is this really in the 80%?? Organization.accreditation 0 unbounded false The qualifications a person has, including format educational achievements, accreditations, and current certifications. All these qualifications may be used to determine what roles a person may play in a healthcare environment For many persons in healthcare, it is necessary to track the qualifications a person has - formal. .plays[Role](classCode='QUAL') Not sure if qualified & accredited are the same. Could potentially propose a new classCode Organization.accreditation.id 0 1 Optional Identifier false The identifier of the accreditation Allows a link back to a accreditation registry, if one exists .identifier Not a humanId? Organization.accreditation.code 0 1 Optional CodeableConcept Accreditation false The type of the accreditation commonly used to determine the roles an organization may perform .code Organization.accreditation.institution 0 1 Optional Resource(Organization) false The organization that confered/confers the accreditation May determine the significance of the qualification, and allows a link back to a qualification registry, if one exists .scopedBy[Organization] Do we need jurisdiction as well? (The jurisdiction is often more relevant than the accrediting org.) Organization.accreditation.period 0 1 Optional Interval(date) false The period for which the accreditation is held Most accreditations are only conferred for a limited time period and must be re-acquired or forfeited .effectiveTime[IVL<TS>] Organization.relatedOrganization 0 unbounded false Other organizations who are related to this person. The relationship might be one of several types: sub- or super- orgnizations (i.e. ward in a hospital, owning corporation of a hospital) or partner organizations (i.e. the operating corporation for a hospital) Need to be able to track many kinds of organizational relationships and use to determine roles and mediate workflows There's no reason why this wouldn't point to another resource. Will map when updated accordingly. Organization.relatedOrganization.id 0 1 Optional HumanId false Identifier the related organization - may be a full link to an Organization resource, or some other kind of identifier may have an identifier for the organization that can be used to source contact details Organization.relatedOrganization.code 1 1 Mandatory CodeableConcept OrganizationRelationship false Code that specifies how this organization is related to the subject. A code is required. Need to know how the organization is related Organization.relatedOrganization.name 0 1 Optional string false A name should be specified for the related organization Organization.relatedOrganization.address 0 unbounded Address false Postal addresses may be provided for the related organization Organization.relatedOrganization.contact 0 unbounded Contact false Contact details (phone, email etc) may be provided for the related organization Organization.relatedOrganization.period 0 1 Optional Interval(date) false The period during which the organizations were related in this fashion Organization relationships are changing all the time Organization.extensions 0 1 Optional false See Extensions [varies] Organization.text 1 1 Narrative false Text summary of organization, fall back for human interpretation .text Prescription Prescription 1 1 Mandatory false Directions provided by a prescribing practitioner for a specific medication to be administered to an individual Used to record details about the prescribed medication, administration schedule, dosage and dispensing. SubstanceAdministration Prescription.id 1 1 Mandatory id false Master Resource Id, always first in all resources Prescription.identifier 0 unbounded Mandatory HumanId true A identifier used in an external system and associated with this medication Prescriptions are almost always assigned specific numerical identifiers .id Prescription.status 1 1 Mandatory code PrescriptionStatus true Actual status of the prescription .statusCode Prescription.patient 1 1 Mandatory Resource(Patient) true The patient the prescription is prescribing medicine for Prescription.prescriber 1 1 Mandatory Resource(Agent) false The clinician or doctor prescribing the medication Prescription.prescribed 1 1 Mandatory dateTime false Date/time on which the prescription was written Prescription.dispense 0 1 Optional false Details of the dispense as requested by the prescriber Prescription.dispense.repeats 0 1 Optional integer false Requested number of repeats Default is "1" Prescription.dispense.quantity 1 1 Mandatory Quantity false Requested quantity per repeat Prescription.dispense.dispenser 0 1 Optional Resource(Agent|Organization) false Person to fullfil the requested dispense Prescription.medicine 1 1 Mandatory false The one single medicatine, vaccine or therapeutic good prescribed in this prescription. Prescription.medicine.productCode 0 1 Conditional Can only be left empty if it cannot be coded Coding MedicationKind true Coded representation of medicine Conformance should be "Required", not "Optional" Prescription.medicine.description 0 1 Conditional Mandatory when medication cannot be coded string false Textual description of medicine, including strength and ingredients Prescription.medicine.activeIngredient 0 unbounded Optional false The substance in the medication formulation that is pharmaceutically active and is responsible for the medication's therapeutic effect Prescription.medicine.activeIngredient.productCode 1 1 Mandatory Coding MedicationKind false Coded representation of active ingredient Prescription.medicine.activeIngredient.quantity 0 1 Optional Ratio false Quantity of active ingredient expressed in relation to the whole of the prepared medicine Prescription.medicine.inactiveIngredient 0 unbounded Optional false Ingredients in the medication that are not active Prescription.medicine.inactiveIngredient.productCode 1 1 Mandatory Coding MedicationKind false Coded representation of the inactive ingredient Prescription.medicine.inactiveIngredient.quantity 0 1 Optional Ratio false Quantity of inactive ingredient expressed in relation to the whole of the prepared medicine Prescription.administrationRequest 1 1 Mandatory false Instructions for the use of the medication. Includes details about the timing schedule, dosis amounts and additional usage instructions. Prescription.administrationRequest.description 0 1 Optional string false Textual description of the use of the medication. Can contain more details than the structured information under this element, but must be in accordance with it. May not contain information about the medicine itself. Prescription.administrationRequest.totalPeriodicDosis 0 1 Optional Ratio false Total dose per day/week or other period when more specific information is missing or cannot be expressed using the timing specifications. It should be possible, as a last resort, to specify e.g. a daily dosis, even if more specific details are unknown Prescription.administrationRequest.start 0 1 Conditional Duration is given OR (Start is given AND (Duration OR End is given)) OR (Duration, Start and End are not given) dateTime false First moment on which medication should be taken Prescription.administrationRequest.end 0 1 Conditional Duration is given OR (Start is given AND (Duration OR End is given)) OR (Duration, Start and End are not given) dateTime false Last moment on which medication should be taken Prescription.administrationRequest.duration 0 1 Conditional Duration is given OR (Start is given AND (Duration OR End is given)) OR (Duration, Start and End are not given) Quantity false Total duration of administration Prescription.administrationRequest.numberOfAdministrations 0 1 Conditional Can be given instead of Duration, as specified above integer false Maximum number of separate administrations before the instruction ends. Prescription.administrationRequest.dosageInstruction 1 unbounded Mandatory false Specification of dose and schedule for administration The can be >1 dosage instruction to support administration of varying doses, resulting in 1 instruction per fixed dose. Prescription.administrationRequest.dosageInstruction.precondition 0 unbounded Optional CodeableConcept AdministrationPrecondition false Precondition for starting the administration specified in this instruction Prescription.administrationRequest.dosageInstruction.prn 0 1 Optional code BooleanYesNo false Pro re nate, "If necessary": Specifies whether administration depens on the state and symptoms of the patient Default is "false" Prescription.administrationRequest.dosageInstruction.additionalInstruction 0 unbounded Optional CodeableConcept AdministrationInstruction false Additional details to guide administration. Especially relevant for medicine administered by patient Prescription.administrationRequest.dosageInstruction.route 0 1 Optional CodeableConcept AdministrationRoute false Route of administration (oral, nasal, intravenous) Since the route of administration is generally determined by the choice of medication, it is not necessary to provide a value in route Prescription.administrationRequest.dosageInstruction.dose[x] 1 1 Mandatory Quantity Interval(Quantity) false Dose per administration, expressed in units of the (prepared) product Dose may be an interval, "2-3 tablets per 4 hours" Prescription.administrationRequest.dosageInstruction.rate 0 1 Optional Quantity false Flow-rate for IV Prescription.administrationRequest.dosageInstruction.schedule 1 unbounded Mandatory Schedule false Schedule for administration. If multiple are given, they are considered to be active in parrallel Will submit proposal to change Schedule type. Prescription.reason 0 1 Optional CodeableConcept PrescriptionReason false Diagnosis which is the reason for prescribing this medicine Prescription.extensions 0 1 Optional false See Extensions Prescription.text 1 1 Mandatory Narrative false Text summary of the prescription, for human interpretation Profile Profile 1 1 Mandatory false A Resource Profile - a statement of constraint on one or more Resources and/or Concept Domains Often called a clinical template Profile.id 1 1 Mandatory id true Globally unique Profile Id (Must be a UUID) Profile.name 1 1 Mandatory string false A free text natural language name identifying the Template. Not expected to be unique Profile.author 1 1 Mandatory false Details of the author who accepts responsibility for publishing the profile Usually an organisation, but may be an individual Profile.author.name 1 1 Mandatory string false The name of the author Profile.author.reference 0 unbounded Optional uri false Reference to the author to assist a user in finding and communicating with the author may be a web site, an email address, a telephone number Profile.intention 0 1 Optional string false A free text natural language description of the intent and scope of the Template. The purpose is to provide the author’s initial intent for the Template in the language specified below. Profile.code 0 unbounded Optional Coding false A set of terms from a controlled reference terminology that may be used to assist with indexing and searching of templates Profile.description 1 1 Mandatory string false A free text natural language description of the Template. Generally, this field should be used for things such as goals, variable lists, instructions for clinical use and interpretation, literature, examples from paper world, mapping from natural language to HL7 and the model itself, etc Profile.evidence 0 unbounded Optional uri false A description, reference or link to a published medical knowledge that was used in the definition of this Template Profile.comments 0 1 Optional string false A statement regarding when this Template should not be used, or may be used erroneously. To define roles where the Template should not be used, or should be used with care. This field is used to expand in detail on the iIntention Profile.status 1 1 Mandatory code ResourceProfileStatus true draft | testing | production | withdrawn | superceded Profile.date 1 1 Mandatory dateTime false The date that the current value for publicationStatus was applied to the Template Profile.endorser 0 unbounded Optional false A list of bodies who have reviewed the Template for clinical accuracy and relevance, and endorsed it for use. Profile.endorser.name 1 1 Mandatory string false The name of the endorsing body Profile.endorser.reference 0 1 Optional uri false Reference to the author to assist a user in finding and communicating with the endorsing body Profile.changes 0 1 Conditional This field must be populated if the template is not the first version. string false A free text description describing the changes in this version of the profile as compared to the previous version. Profile.supercedes 0 unbounded Optional uri false A template that is supercded by this template (maybe a previous version) Profile.profile 0 unbounded Optional uri false Additional other profiles that apply to this conformance statement. Generally these profiles make constraints on the bindings of concept domains / value sets Profile.resource 0 unbounded Mandatory Constraint false Resource Type with constraints Profile.binding 0 unbounded Mandatory false Profile.binding.name 1 1 Mandatory string false The name of the concept domain that this profile is declaring a constraint on Profile.binding.type 1 1 Mandatory code ConceptBindingType false The form of the binding Profile.binding.details 0 1 Conditional May be required depending on the value of binding.type string false extra details - see notes Profile.binding.reference 0 1 Conditional May be required depending on the value of binding.type uri false source of binding content Profile.binding.code 0 unbounded Conditional May be required depending on the value of binding.type Coding false enumerated codes that are the binding Profile.extensions 0 1 Optional false See Extensions Profile.text 1 1 Mandatory Narrative false Text summary of resource profile for human interpretation Patient Patient 1 1 Mandatory false A patient is a person or animal that is receiving care Tracking patient is the center of the healthcare process Patient Patient.id 1 1 Mandatory id false Master Resource Id, always first in all resources .id(scope=OBJ) Patient.link 0 unbounded Mandatory Resource(Patient) true A linked patient record is a record that concerns the same patient. Records are linked after it is realised that at least one was created in error. Due to the clerical errors associated with the difficulties of identifying humans consistently, duplicate patient records are frequently created in error More then two patient records may be linked. Note that there is a special transaction for linking patient records in the RESTful context, as record linking consistency must be maintained Patient.active 1 1 Mandatory boolean true Whether the patient record is in use, or has been removed from active use Need to be able to mark a patient record as not to be used because it was created in error If a record is inactive, and linked to an active record, then future patient/person/record updates should occur on the other patient Patient.person 0 1 Conditional Either an animal or a person must be provided, but not both Resource(Person) true The person that this patient record is about Need to link this patient record to a known and identifiable person (or animal) Patient.animal 0 1 Conditional Either an animal or a person must be provided, but not both Resource(Animal) false The animal that this patient record is about Need to link this patient record to a known and identifiable animal (or person) Patient.provider 1 1 Mandatory Resource(Organization) true The provider for whom this is a patient record Need to know who recognises this patient record But is thie same as institution above? Patient.identifier 0 unbounded HumanId true An identifier that applies to this person as a patient Patients are almos always assigned specific numerical identifiers Patient.diet 0 1 Optional CodeableConcept PatientDiet false Dietary restrictions for the patient Track patients reported dietary restrictions to help with catering requirements not for specifying medical diets, but for casual dietary restrictions such as vegetarian, diary-free, nut-free, etc Patient.confidentiality 0 1 Optional CodeableConcept PatientConfidentiality false Confidentiality of the patient records Need to be able to track which patient records are particularly sensitive Confidentiality tracking also occurs at more detailed points in the medical record Patient.recordLocation 0 1 Optional CodeableConcept PaperRecordLocation false The location of the paper record for the patient, if there is one Track old paper records where these are still in use Patient.extensions 0 1 Optional false See Extensions Patient.text 1 1 Mandatory Narrative false Text summary of person, for human interpretation Person Person 1 1 Mandatory false A person who is involved in the healthcare process Need to track persons across multiple roles Person(classCode=PSN, determinerCode=INST) Person.id 1 1 Mandatory id false Master Resource Id, always first in all resources .id(scope=OBJ) Person.identifier 0 unbounded HumanId true Identifier for the person that is used to identify the person across multiple disparate systems and also for face to face identification of the person People are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the patient. .plays:Role(classCode='IDENT').id PID-3 Person.name 0 unbounded HumanName true A name associated with the person Need to be able to track the person by multiple names Person may have multiple names with different uses or applicable periods .name PID-5, PID-9 Person.address 0 unbounded Address false An address for the person May need to keep track of persons addresses for contacting, billing or reporting requirements and also to help with identification Person may have multiple addresses with different uses or applicable periods .addr PID-11 Person.contact 0 unbounded Contact false A contact detail for the person May need to have options for contacting the person urgently, and also to help with identification Person may have multiple contacts with different uses or applicable periods .telecom PID-13, PID-14 Person.dob 0 1 Optional dateTime true The birth date for the person Age of person drives many clinical processes. At least a estimated year should be provided as a guess if the real dob is unknown .birthTime Person.gender 0 1 Optional CodeableConcept AdministrativeGender true Administrative Gender Patient Identification, and also for managing the patient .administrativeGender Person.religion 0 1 Optional CodeableConcept Religion false The religious denomination to which a person professes affiliation The religion of a person may influence ancilliary processes around the provision of healthcare, and may provide general advice with regard to diet, etc Not all people have a formal religious affiliation .religiousAffiliationCode Person.race 0 unbounded Optional CodeableConcept Race false blah balh This is added because many jurisdictions insisted on it Some places do not use this! .raceCode Person.qualification 0 unbounded false The qualifications a person has, including formal educational achievements, accreditations, and current certifications. All these qualifications may be used to determine what roles a person may play in a healthcare environment For many persons in healthcare, it is necessary to track the qualifications a person has - formal. .plays:Role(classCode='QUAL') Person.qualification.id 0 1 Optional Identifier false The identifier of a qualification Allows a link back to a qualification registry, if one exists .identifier Person.qualification.code 0 1 Optional CodeableConcept Qualifications false The type of the qualification commonly used to determine the roles a person may play .code Person.qualification.institution 0 1 Optional Resource(Organization) false The organisation that confered/confers the qualification May determine the significance of the qualification, and allows a link back to a qualification registry, if one exists .scopedBy:Organization Person.qualification.period 0 1 Optional Interval(date) false The period for which a qualification is held Some qualifications are only conferred for a limited time period and must be re-acquired or forfeited Formal degrees may have a known start date, but no end date .effectiveTime:IVL_TS Person.language 0 unbounded false A language spoken by the person, with proficiency If a patient does not speak the local language, interpreters may be required, so languages spoken and profiency is an important things to keep track of both for patient and other persons of interest If no language is specified, this *implies* that the default local language is spoken .LanguageCommunicationCode Person.language.code 1 1 Mandatory code Language false A code that identifies the language So just ISO 639-3? Not allowing ENG-CA or something? .languageCode Person.language.use 0 1 Optional code LanguageUse false A code the describes how well the language is spoken No differentiation is made between spoken and written functionality here .proficiencyLanguageCode Person.relatedPerson 0 unbounded false Other persons who are related to this person. The relationship might be one of several types: kin (familial or marital), financial or legal (such as guardian), biological (e.g. donor, donation-recipient) or casual (i.e. friend). Need to be able to track next of kin, or other people who may need to contacted/consulting regarding the patient's healthcare status or who might otherwise influence their treatment .plays:Role(classCode='REL') Person.relatedPerson.id 0 1 Optional HumanId false Identifier the related person - may be a full link to a Person resource, or some other kind of identifier may have an identifier for the person that can be used to source contact details .scopedBy:Person.identifier Person.relatedPerson.role 1 1 Mandatory CodeableConcept PersonRelationship false Code that specifies how this person is related to the subject. A code is required. Need to know how the person is related .code Person.relatedPerson.name 0 1 Optional HumanName false A name should be specified for the related person .scopedBy:Person.name Person.relatedPerson.contact 0 unbounded Contact false Contact details (phone, email etc) should be provided for the person .scopedBy:Person.telecom Person.extensions 0 1 Optional false See Extensions Person.text 1 1 Mandatory Narrative false Text summary of person, for human interpretation LabReport LabReport 1 1 Mandatory false The findings and interpretation of pathology tests performed on tissues and body fluids. This is typically done in a laboratory but may be done in other environments such as at the point of care Use to record any pathology test result, including the result of a test on a specimen taken as part of a composite procedure or operation. Not to be used for reporting on non-pathology test results e.g. diagnostic imaging, ECG or respiratory function tests. Not to be used to represent an entire cumulative report. This Pathology test result archetype represents only one of the result sets that is usually viewed as a vertical in a cumulative test report. A cumulative report is a view that is constructed from the results represented by multiple OBSERVATION archetypes. This archetype is suitable for representation of general pathology test results, but not intended to cover full synoptic reports. For these, additional resources are required to represent the data properly Observation[isNormalAct() and subsumesCode("ActClass#OBS", classCode) and moodCode="EVN" and domainMember("LabObservationType", code)] LabReport.id 1 1 Mandatory id false Master Resource Id, always first in all resources unique(./id[isNormalDatatype() and displayable="false" and scope="OBJ" and reliability="ISS"]) LabReport.status 1 1 Mandatory code LabReportStatus true The status of the pathology test result as a whole Labs routinely issue provisional/incomplete reports, or withdraw previously released reports registered: ./statusCode[isNormalDatatype()]="new"; interim: ./statusCode[isNormalDatatype()]="active"; final: ./statusCode[isNormalDatatype()]="complete" and not(./inboundRelationship[typeCode="SUBJ" and isNormalActRelationship()]/source[subsumesCode("ActClass#CACT") and moodCode="EVN" and domainMember("ReviseLabOrder", code) and isNormalAct()]); amended: ./statusCode[isNormalDatatype()]="complete" and ./inboundRelationship[typeCode="SUBJ" and isNormalActRelationship()]/source[subsumesCode("ActClass#CACT") and moodCode="EVN" and domainMember("ReviseLabOrder", code) and isNormalAct() and statusCode="completed"]; cancelled: ./statusCode[isNormalDatatype()]="aborted"; withdrawn: ./statusCode[isNormalDatatype()]="obsolete" LabReport.issued 1 1 Mandatory instant true The date and/or time that the result was issued from the source for the recorded ‘Test result status Clinicians need to be able to check the date that the report was released May be different from LabReport.updated, because that is the status of this record, not the report the record is about firstOf(unique(./participation[isHighest(priorityCode) and typeCode="VRF" and isNormalParticipation()]/time[type="TS"]), unique(./participation[isHighest(priorityCode) and typeCode="AUT" and isNormalParticipation()]/time[type="TS"])) LabReport.patient 1 1 Mandatory Resource(Patient) true The patient about who the report is about Must know the patient context unique(./participation[isHighest(priorityCode) and typeCode="SBJ" and isNormalParticipation()]/role[classCode="PAT"]) need to check the wording -is it about, upon, for? LabReport.admission 0 1 Optional Resource(Admission) false The admission that this diagnostic investigation is associated with Some institutions track and file diagnostic reports under a specific admission unique(./inboundRelationship[isHighest(priorityCode) and typeCode="SUBJ" and isNormalActRelationship()]/source[subsumesCode("ActClass#ENC", code) and moodCode="EVN" and isNormalAct()]) Reckon this is not 80% LabReport.laboratory 1 1 Mandatory Resource(Organization) false The laboratory service that issued the report Need to know how to contact if there are queries about the results. Also may need to track the source of reports for secondary data analysis This is not necessarily the source of the atomic reports - it's the lab that takes responsibility for the clinical report unique(./participation[isHighest(priorityCode) and typeCode="AUT" and isNormalParticipation()]/role[subsumesCode("RoleClass#ASSIGN", classCode)]/scoper[subsumesCode("EntityClass#ORG", classCode) and determinerCode="INSTANCE"]) LabReport.reportId 0 1 Optional id false The local ID assigned to the report by the order filler, usually by the Laboratory Information System (LIS). Need to know what identifier to use when making queries about this report from the source laboratory unique(./id[displayable="true" and scope="OBJ"]) LabReport.requestDetail 0 unbounded false Details concerning a single pathology test requested. Need to be able to track completion of requests based on reports issued, and also to report what diagnostic test swere requested (not always the same as what is delivered) Note: Usually there is one test request for each result, however in some circumstances multiple test requests may be represented using a single Pathology test result resource unique(./outboundRelationship[typeCode="FLFS" and isNormalActRelationship()]/target[subsumesCode("ActClass#OBS", classCode) and subsumes("ActMood#PRMS", moodCode) and isNormalAct()]) LabReport.requestDetail.requestOrderId 0 1 Optional Identifier false The local ID assigned to the order by the order requester. Need to be able to track completion of requests based on reports issued Equivalent to the Placer Order Identifier unique(./outboundRelationship[typeCode="FLFS" and isNormalActRelationship()]/target[subsumesCode("ActClass#OBS", classCode) and subsumes("ActMood#RQO", moodCode) and isNormalAct()]/id[scope="OBJ" and displayable="true"]) Reckon this is not 80% LabReport.requestDetail.receiverOrderId 0 1 Optional Identifier false The local ID assigned to the test order by the order filler, usually by the Laboratory Information System (LIS). Need to be able to track completion of requests based on reports issued Usually equivalent to the DICOM Accession Number and the Filler Order Identifier. unique(./id[scope="OBJ" and displayable="true"]) Reckon this is not 80% LabReport.requestDetail.requestTest 0 unbounded CodeableConcept LabRequests false Identification of pathology test requested, Need to be able to report what diagnostic test swere requested (not always the same as what is delivered) Useful where the test requested differs from the test actually performed. ./code LabReport.requestDetail.requester 0 1 Optional Resource(Agent|Organization) false Details of the clinician or organisation requesting the laboratory test. The requesting clinician may need to be contacted concerning the interpretation of the lab report Agent: unique(./participation[isHighest(priorityCode) and typeCode="AUT" and isNormalParticipation()]/role[subsumesCode("RoleClass#ASSIGN", classCode)] Organization: unique(./participation[isHighest(priorityCode) and typeCode="AUT" and isNormalParticipation()]/role[subsumesCode("RoleClass#ASSIGN", classCode)]/scoper[subsumesCode("EntityClass#ORG", classCode) and determinerCode="INSTANCE" and code[isNormalDatatype]]) LabReport.requestDetail.clinicalInfo 0 1 Optional Resource(Any) false Details of the clinical information provided to the laboratory along with the original request Knowing the clinical information may influence the interpretation of the result ./outboundRelationship[typeCode="PERT" and isNormalActRelationship()]/target This isn't really *ANY* resource. You can't send a drug or an Animal or a bunch of other things. What you really want here are "acts", and I suspect there's a constraint that the subject of the LabReport must have participated in them as subject or perhaps in some other way. LabReport.reportName 1 1 Mandatory CodeableConcept LabReportNames true Identification of the pathology test performed, sometimes including specimen type. Need to know what report this is, so clinicians can filter/find the reports they are looking for A test result may be for a single analyte, or a group of items, including panel tests. ./code LabReport.service 0 1 Optional CodeableConcept LabServices false The diagnostic service that performs the examination e.g. biochemistry, haematology. Help clinicians filter/find the reports they are looking for unique(./inboundRelationship[typeCode="COMP" and isNormalActRelationship()]/source[subsumesCode("ActClass#LIST", classCode) and moodCode="EVN" and inDomain(code,"Lab Service") and isNormalAct()]/code I'm not sure this is in the 80%. LabReport.diagnosticTime 1 1 Mandatory dateTime true The diagnostically relevant time for this report Need to know where in the patient history to file/present this report The diagnostically relevant time can be derived from the specimen collection times, but the specimen information is not always available, and the exact relationship is not always automatic ./effectiveTime[type="TS"] LabReport.specimen 0 unbounded Resource(Specimen) false Details about the specimen if all individual test results are derived from the same specimen Need to be able to report information about the collected specimens on which the report is based If the specimen is sufficiently specified with a code in the Test result name, then this additional data may be redundant. If there are multiple specimens, these may be represented per 'Result group' unique(./participation[typeCode="SUBJ" and isNormalParticipation()]/role[subsumesCode("RoleClass#SPEC", classCode)]) LabReport.resultGroup 1 unbounded true A group of results. Results may be grouped by specimen, or by some value in LabReport.resultGroup.name to describe what binds all the results together. Need to be able to report groups of results, where the result grouping is arbitrary, but meaningful Many (most) lab reports don't really have a meaningful group. In these cases, just create a single group with no specimen or name ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[isNormalAct() and subsumesCode("ActClass#OBS", classCode) and moodCode="EVN" and fromDomain(code, "LabObservationBattery")] LabReport.resultGroup.name 0 1 Optional CodeableConcept LabResultGroupNames true A code or name that describes the group of results For example, the antibody code for a goup of antibody related test, or the organism code for a group of isolate/sensitivities. Leave blank if there is no particular meaning associated with the group ./code LabReport.resultGroup.specimen 0 1 Optional Resource(Specimen) false Details about the individual specimen to which these ‘Result group’ test results refer, where testing of multiple specimens is required. Need to be able to report information about the collected specimens on which the report is based unique(./participation[typeCode="SBJ" and isNormalParticipation()]/role[subsumesCode("RoleClass#SPEC", classCode)]) LabReport.resultGroup.result 1 unbounded true Specific detailed result, including both the value of the result item, and additional information that may be useful for clinical interpretation. Results include whatever specific data items pathology labs report as part of the clinical service; it is not confined to measurements. Need to report results with information that assist with interpretation ./outboundRelationship[typeCode="COMP" and isNormalActRelationship()]/target[subsumesCode("ActClass#OBS", classCode) and moodCode="EVN" and isNormalAct() and fromDomain(code, "LabObservationResult")] LabReport.resultGroup.result.name 0 1 Optional CodeableConcept LabResultNames true Identifies the meaning of the value Need to know what the result is about results are fundamentally a name - value pair with additional clarifying information ./code LabReport.resultGroup.result.value[x] 0 1 Optional Quantity CodeableConcept Attachment Ratio Choice Interval(dateTime) string *unbound* true Actual value of the result. Most result values will be numerical measurements, but others may be coded concepts, free text, or multimedia images Need a value for the result ./value LabReport.resultGroup.result.flag 0 1 Optional code LabResultFlag true Flag indicating the abnormal status of the result ./interpretationCode The proposed set of codes are too narrow (and doesn't map well to v3.) LabReport.resultGroup.result.status 1 1 Mandatory code LabReportStatus true The status of the result value Need to track the status of individual results - some results are finalised before the whole report is finalised (as per LabReport.status) LabReport.resultGroup.result.comments 0 1 Optional string true May include statements about significant, unexpected or unreliable. values, or information about the source of the value where this may be relevant to the interpretation of the result. Need to be able to provide free text additional information unique(./inboundRelationship[typeCode="SUBJ" and isNormalActRelationship()]/source[subsumesCode("ActClass#OBS", classCode) and moodCode="EVN" and mapsTo(code, "LOINC# 48767-8") and isNormalAct()]/value[type="ST"]) LabReport.resultGroup.result.referenceRange 0 unbounded true Guidance on how to interpret the value by comparison to a normal or recommended range Need to be able to provide multiple reference ranges Most results only have one reference range. Some non-numerical results don't have a reference range ./outboundRelationship[typeCode="REFV" and isNormalActRelationship()]/target[subsumesCode("ActClass#OBS", classCode) and moodCode="EVN" and isCriterionInd="true" and isNormalAct()] Are multiple reference ranges in the 80%? LabReport.resultGroup.result.referenceRange.meaning 0 1 Optional CodeableConcept LabReferenceRanges false Code for the meaning of the reference range Need to be able to say what kind of reference range this is - normal, recommended, therapeutic, or perhaps what state this reference range applies to (i.e. hormonal cycles) ./interpretationCode LabReport.resultGroup.result.referenceRange.range[x] 1 1 Mandatory Quantity Interval(Quantity) string false Actual value of the reference range. May be a quantity (<20mg/L), an interval (10-20 umol/L), or some text Need to be able to report numerical or text reference ranges, and handle legacy data Text reference ranges are typically used in endocrinology, or for legacy data with string reference ranges ./value[type=("PQ", "IVL_PQ", "ST")] LabReport.conclusion 0 1 Optional Narrative true Concise and clinically contextualised narrative interpretation of the pathology test results. Need to be able to provide a conclusion that is not lost amongst the basic result data common reports don't have a conclusion, but some do unique(./inboundRelationship[typeCode="SPRT" and isNormalActRelationship()]/source[subsumesCode("ActClass#OBS", classCode) and moodCode="EVN" and mapsTo(code, "LOINC# 48767-8") and isNormalAct()]/value[type="ST"]) Is this in the 80%? LabReport.codedDiagnosis 0 unbounded CodeableConcept LabDiagnosisCodes false Codes for the conclusion unique(./inboundRelationship[typeCode="SPRT" and isNormalActRelationship()]/source[subsumesCode("ActClass#OBS", classCode) and moodCode="EVN" and subsumesCode(code, "LOINC# 54531-9") and isNormalAct()]/value[type="CD"]) LabReport.representation 1 unbounded Attachment true Rich text representation of the entire result as issued by the diagnostic service. Multiple formats are allowed but they must be semantically equivalent. Laboratory needs to be able to provide it's own fully formatted report for clinical fidelity Possible formats: text/html, text/plain, text/rtf, application/msword, application/pdf, application/rtf, application/vnd.oasis.opendocument.text, application/vnd.openxmlformats-officedocument.wordprocessingml.document ./text[type="ED"] LabReport.extensions 0 1 Optional false See Extensions N/A LabReport.text 1 1 Mandatory Narrative false Text summary of report, for human interpretation unique(./text[type="ST"]) DocumentConformance DocumentConformance 1 1 Mandatory false A conformance statement about how one or more FHIR documents DocumentConformance.id 1 1 Mandatory id false Globally unique Conformance Statement Id (Must be a UUID) DocumentConformance.date 1 1 Mandatory dateTime false Date that this conformance statement is published DocumentConformance.publisher 1 1 Mandatory false The organization that publishes this conformance statement DocumentConformance.publisher.name 1 1 Mandatory string false Name of Organization DocumentConformance.publisher.address 0 unbounded Optional Address false Address of Organization DocumentConformance.publisher.contact 0 unbounded Optional Contact false Contacts for Organization DocumentConformance.software 0 1 Optional false The software that is covered by this conformance statement DocumentConformance.software.name 1 1 Mandatory string false Name software is known by DocumentConformance.software.version 1 1 Mandatory string false Version covered by this statement DocumentConformance.software.releaseDate 0 1 Optional dateTime false Date this version released DocumentConformance.profile 0 unbounded Optional uri false Additional other profiles that apply to this conformance statement. Generally these profiles make constraints on the bindings of concept domains / value sets DocumentConformance.document 1 unbounded Mandatory false A document definition DocumentConformance.document.name 1 1 Mandatory string false Name for this particular document profile DocumentConformance.document.purpose 0 1 Optional string false Human description of this particular profile DocumentConformance.document.resource 1 unbounded Mandatory Constraint false Constraint on a resource used in the document The first resource is the document resource DocumentConformance.extensions 0 1 Optional false See Extensions DocumentConformance.text 1 1 Mandatory Narrative false Text summary of conformance profile for human interpretation MessageConformanceEventMode The mode of a message conformance statement CodeList urn:hl7-org:sid/fhir/message-conformance-event-mode sender The application sends requests and receives responses receiver The application receives requests and sends responses ResourceProfileStatus The lifecycle status of a Resource Profile CodeList urn:hl7-org:sid/fhir/resource-profile-status draft This profile is still under development testing this profile was authored for testing purposes (or education/evaluation/evangelisation) production This profile is ready for use in production systems withdrawn This profile has been withdrawn superceded This profile was superceded by a more recent version DataType The type of an element - one of the FHIR data types Special DataType MediaType The mime type of an attachment External BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049) http://www.rfc-editor.org/bcp/bcp13.txt NarrativeStatus The status of a resource narrative CodeList urn:hl7-org:sid/fhir/narrative-status generated The contents of the narrative are entirely generated from the structured data in the resource. extensions The contents of the narrative are entirely generated from the structured data in the resource, and some of the structured data is contained in extensions additional The contents of the narrative contain additional information not found in the structured data AgentRole The role a person plays representing an organization Unbound PersonRelationship The relationship a person has to the subject, including familial, marital, financial, legal, and casual relationships Unbound AnimalSpecies The species of an animal Unbound IdentifierType The type of human identifier CodeList urn:hl7-org:sid/fhir/identifier-type account Account number An identifier that is unique to an account. credit Credit Card Number A credit card number (or debit card). microchip Microchip Number implanted, for animals, or a worn RFID for humans registry A Registry Number insurance Insurance Scheme Member Number Identifies the person as a member of an insurance scheme. national National Healthcare Identifier May not only be used for healthcare. ssn National Social Security Number state State Healthcare Identifier May not only be used for healthcare. patient Patient identifier Frequently called MRN (medical record number) or UR (unit record number). facility Facility ID provider Provider number a number allocated to a person as a provider of healthcare resources. AnimalRelationship The relationship of an animal to another entity (person, corporation, or other animal) Unbound LabReportNames codes for report names Preferred LOINC PrescriptionStatus The status of a prescription CodeList urn:hl7-org:sid/fhir/prescription-status active Patient is using the prescribed medicin completed Prescription is no longer current PatientConfidentiality The confidentiality of the records associated with this patient Unbound AddressUse The use of an address CodeList urn:hl7-org:sid/fhir/address-use home A communication address at a home. work An office address. First choice for business related contacts during business hours. temp A temporary address. The period can provide more detailed information. old This address is no longer in use (or was never correct, but retained for records) NamePartType Type of a part of a human name CodeList urn:hl7-org:sid/fhir/name-part-type family Family name, this is the name that links to the genealogy. In some cultures (e.g. Eritrea) the family name of a son is the first name of his father. given Given name. NOTE Not to be called first name since given names do not always come first. . title Part of the name that is acquired as a title due to academic, legal, employment or nobility status etc. NOTE Title name parts include name parts that come after the name, such as qualifications. ContactUse How to use this address CodeList urn:hl7-org:sid/fhir/contact-use home A communication contact at a home; attempted contacts for business purposes might intrude privacy and chances are one will contact family or other household members instead of the person one wishes to call. Typically used with urgent cases, or if no other contacts are available. work An office contact. First choice for business related contacts during business hours. temp A temporary contact. The period can provide more detailed information. old This contact is no longer in use (or was never correct, but retained for records) mobile A telecommunication device that moves and stays with its owner. May have characteristics of all other use codes, suitable for urgent matters, not the first choice for routine business NarrativeMapSource Which is the source in a Narrative <-> Data mapping CodeList urn:hl7-org:sid/fhir/narrative-map-source text The text is the original data data The data is the original data BooleanYesNo Either yes or no, true or false CodeList urn:hl7-org:sid/fhir/boolean-yes-no yes TRUE no FALSE LabRequests codes for requestable tests Unbound AnimalGender The gender of an animal Unbound AnimalStrain The strain of an animal Unbound Religion The denomination to which a person professes affiliation Unbound PrescriptionReason Medical reason for prescribing a medicine External ICD-10, ICPC-1 Race The race of the person Preferred HL7 v2 table 0200 ContactSystem What kind of contact this is CodeList urn:hl7-org:sid/fhir/contact-system phone the value is a telephone number used for voice calls. Use of full international numbers starting with + is recommended to enable automatic dialing support but not required. fax the value is a fax machine. Use of full international numbers starting with + is recommended to enable automatic dialing support but not required. email the value is an email address url The value is a url. This is intended for various personal contacts including blogs, twitter, facebook etc. Do not use for email addresses Accreditation Accreditations an organization may be granted Unbound DocumentSectionType Type of a clinical document section Preferred LOINC LabDiagnosisCodes Codes for laboratory diagnoses Suggestion SNOMED-CT LabReportStatus The status of a report or result item CodeList urn:hl7-org:sid/fhir/lab-report-status registered The existence of the result is registered, but there is no result yet available interim This is an initial or interim result: data may be missing or verification not been performed final The result is complete and verified by the responsible pathologist amended The result has been modified subsequent to being Final, and is complete and verified by the responsible pathologist cancelled The result is unavailable because the test was not started or not completed (also sometimes called aborted) withdrawn The result has been withdrawn following previous Final release AdministrationPrecondition Precondition for administering medication External NHG Table 25b ConformanceType The conformance value for an element CodeList urn:hl7-org:sid/fhir/conformance-type Mandatory The element is or must always be present without a dataAbsentReason Conditional The element may need to be present (with no dataAbsentReasons) depending on the condition Optional The element may or may not be present Prohibited The element can not present or will be rejected if received AdministrationInstruction Instructions for administering medication External NHG Table 25b DataAbsentReason Used to specify why the normally expected content of the data element is missing CodeList urn:hl7-org:sid/fhir/data-absent-reason unknown The value is not known asked The source human does not know the value temp There is reason to expect (from the workflow) that the value may become known notasked The workflow didn't lead to this value being known masked The information is not available due to security, privacy or related reasons Using masked may be breach of security or confidentiality, but there are times when it's use is required to support alternate workflows for gaining access to denied information. unsupported The source system wasn't capable of supporting this element astext The content of the data is represented as text error Some system or workflow process error means that the information is not available LabResultNames codes for results Preferred LOINC PaperRecordLocation A physical location for a record. (Usually site specific) Unbound DocumentAuthenticationMode The way in which a person authenticated a document CodeList urn:hl7-org:sid/fhir/document-authentication-mode personal The person authenticated the document in their personal capacity professional The person authenticated the document in their professional capacity legal The person authenticated the document and accepted legal responsibility for it's content official The organization authenticated the document as consistent with their policies and procedures Industry Code for the type of industry Reference HL7 v3 OrganizationIndustryClass value set ConceptBindingType The type of a binding for a concept domain CodeList urn:hl7-org:sid/fhir/concept-binding-type Unbound The concept domain is not bound to anything CodeList The concept domain is bound to a list of supplied codes - only those codes are allowed Reference The concept domain references some external definition by a provided reference Preferred The concept domain references a set of preferred terms Suggestion This profile was superceded by a more recent version External The concept domain is defined by an external authority identified in the reference PatientDiet casual dietary restrictions associated with this patient Unbound MedicationKind The kind of medication, vaccine or therapeutic material External G-Standaard (Netherlands), AMT (Australie) AddressPartType Type of address part CodeList urn:hl7-org:sid/fhir/address-part-type part Part of an address line (typically used with an extension that further defines the meaning of the part). line A line of an address (typically used for street names & numbers, unit details, delivery hints etc) . city The name of the city, town, village, or other community or delivery centre. state sub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (i.e. US 2 letter state codes). country Country. ISO 3166 3 letter codes can be used in place of a full country name. zip A postal code designating a region defined by the postal service. dpid A value that uniquely identifies the postal address. (often used in barcodes). LabResultGroupNames codes for result groups Preferred LOINC LanguageUse How well a person speaks a language CodeList urn:hl7-org:sid/fhir/language-use none The person does not speak the language at all poor The person has minimal functional capability in the language useable The person can use the language, but may not be full conversant, particularly with regards to health concepts fluent The person is fully capable of using the language Qualifications Formal qualifications, accreditations, and Certifications acquired by a person Unbound MessageEvent One of the message types defined in FHIR messaging Special MessageEvent ResourceType One of the resource types defined in FHIR messaging Special ResourceType EventTiming A real world event that a schedule is related to CodeList urn:hl7-org:sid/fhir/event-timing HS event occurs duration before the hour of sleep (or trying to) WAKE event occurs duration after waking AC event occurs duration before a meal (from the latin ante cibus) ACM event occurs duration before breakfast (from the latin ante cibus matutinus) ACD event occurs duration before lunch (from the latin ante cibus diurnus) ACV event occurs duration before dinner (from the latin ante cibus vespertinus) PC event occurs duration after a meal (from the latin post cibus) PCM event occurs duration after breakfast (from the latin post cibus matutinus) PCD event occurs duration after lunch (from the latin post cibus diurnus) PCV event occurs duration after dinner (from the latin post cibus vespertinus) *unbound* Unbound ResourceIdSource The system responsible for the provision of a resource unique id CodeList urn:hl7-org:sid/fhir/resource-id-source client The client must provide a unique resource id server The server defines the id and will reject any client attempt to define it either The client can provide a unique resource id, or the server will define it instead DocumentType Type of a clinical document Preferred LOINC NameUse The use of a human name CodeList urn:hl7-org:sid/fhir/name-use usual Known as/conventional/the one you normally use official The formal name as registered in an official (government) registry, but which name might not be commonly used. May be called legal name. temp A temporary name. A name valid time can provide more detailed information. This may also be used for temporary names assigned at birth or in emergency situations. anonymous Anonymous assigned name, alias, or pseudonym (used to protect a person's identity for privacy reasons) old This name is no longer in use (or was never correct, but retained for records) maiden A name used prior to marriage. Marriage naming customs vary greatly around the world. This name use is for use by applications that collect and store maiden names. Though the concept of maiden name is often gender specific, the use of this term is not gender specific. The use of this term does not imply any particular history for a person‘s name, nor should the maiden name be determined algorithmically ExtensionState The state of an extension CodeList urn:hl7-org:sid/fhir/extension-state must-understand The extension contains information that qualifies or negates another element, and must be understood by an application processing the resource superceded The extension has been promoted into the main content of the resource, and the content is found at the reference. The extension continues to be defined for backward compatibility LabResultFlag codes for result flags CodeList urn:hl7-org:sid/fhir/lab-result-flag - -- --- + ++ +++ OrganisationType The type of an organisation Suggestion SNOMED-CT, and the HL7 v3 Entity Code table QuantityStatus how the Quantity should be understood and represented CodeList urn:hl7-org:sid/fhir/quantity-status < The actual value is less than the given value <= The actual value is less than or equal to the given value >= The actual value is greater than or equal to the given value > The actual value is greater than the given value ResponseCode The kind of response to a message CodeList urn:hl7-org:sid/fhir/response-code ok The message was accepted and processed without error error Some internal unexpected error occured - wait and try again. Note - this is usually used for things like database unavailable, which may be expected to resolve, though human intervention may be required rejection The message was rejected because of some content in it. There is no point in re-sending without change. The response narrative must describe what the issue is rules The message was rejected because of some event-specific business rules, and it may be possible to modify the request and re-submit (as a different request). The response data must clarify what the change would be, as described by the event definition undeliverable A middleware agent was unable to deliver the message to it's supposed destination AdministrationRoute Route by which a medication is administered External G-Standaard subtable 0007 LabServices codes for laboratory services Reference HL7 v2 table 0074 RestfulConformanceMode The mode of a restful conformance statement CodeList urn:hl7-org:sid/fhir/restful-conformance-mode client The application acts as a server for this resource server The application acts as a client for this resource AdministrativeGender The gender of a person used for administrative purposes Unbound OrganizationRelationship The relationship an organization has to the subject, including sub and super organizations, and other kind of relationships such as partner organisations Unbound EventReason The reason for an event occurring Unbound Language A human language External ISO 639-3 http://www.sil.org/iso639-3/codes.asp LabReferenceRanges Code for the meaning of a reference range Unbound