STU 3 Candidate

This page is part of the FHIR Specification (v1.4.0: STU 3 Ballot 3). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3 R2

1.35 FHIR W5 Report

FHIR Infrastructure Work GroupMaturity Level: N/ABallot Status: DSTU 2

Concise

Resourceidid.versionstatusclassgradewhatwho.focuscontextwhen.initwhen.plannedwhen.donewhen.recordedwho.authorwho.sourcewho.actorwho.causewho.witnesswhowherewhy
Clinical Resources
AllergyIntolerance identifier* status type
category		 criticality substance patient recordedDate recorder reporter
BodySite
CarePlan status context
CareTeam identifier* status type* subject period member
ClinicalImpression status patient date assessor
Condition identifier* clinicalStatus
verificationStatus		 category severity code patient encounter onset[x] abatement[x] dateRecorded asserter
DecisionSupportRule
DecisionSupportServiceModule
DetectedIssue identifier category severity patient date author
DiagnosticOrder identifier* status priority subject encounter orderer
DiagnosticReport identifier* status category code subject encounter effective[x] issued performer
FamilyMemberHistory identifier* status patient date
Goal identifier* status subject statusDate author
GuidanceResponse
ImagingExcerpt uid patient authoringTime author
ImagingObjectSelection uid patient authoringTime author
ImagingStudy uid
accession
identifier*		 availability modalityList* patient started order*
referrer		 interpreter
Immunization identifier* status
wasNotGiven		 vaccineCode patient encounter date reported performer requester location
ImmunizationRecommendation identifier* patient
Library
Measure
MeasureReport
Medication code
isBrand		 manufacturer
MedicationAdministration identifier* status medication[x] patient encounter effectiveTime[x] practitioner
MedicationDispense identifier status medication[x] patient dispenser
MedicationOrder identifier* status medication[x] patient encounter dateWritten prescriber reasonCode*
reasonReference*
MedicationStatement identifier* status medication[x] patient effective[x] informationSource
ModuleDefinition identifier*
NutritionOrder identifier* status type*
modifier
type
baseFormulaType
additiveType		 patient encounter dateTime orderer
Observation identifier* status category code
code		 subject encounter effective[x] issued performer*
OrderSet
Procedure identifier* code subject encounter performed[x] actor location
ProcedureRequest identifier* status code priority subject encounter scheduled[x] orderedOn orderer performer
Protocol identifier*
title		 status type subject group purpose author
ReferralRequest identifier* status category
type		 priority serviceRequested* patient context authored fulfillmentTime requester recipient* reason
RiskAssessment identifier method subject encounter date performer
Sequence
Specimen identifier*
accessionIdentifier		 status type subject collected[x] receivedTime collector
VisionPrescription
Administrative Resources
Device identifier*
udiCarrier		 status type
lotNumber
manufacturer
manufactureDate
expirationDate
model
version		 patient owner
contact*		 location
url
DeviceComponent identifier type lastSystemChange
DeviceMetric identifier type
category
Group identifier* active type
actual		 code
HealthcareService identifier* serviceCategory location*
Location identifier* status mode
type
physicalType
Organization identifier* active type
Patient identifier* active
Person identifier* active
Practitioner identifier* active period location*
PractitionerRole identifier* active period location*
RelatedPerson identifier* relationship period
Substance identifier* category* code
Workflow Resources
Appointment identifier* status specialty*
priority		 start end actor
AppointmentResponse identifier* start end actor
Communication identifier* status category recipient*
subject		 encounter
requestDetail		 sent received sender
CommunicationRequest identifier* status category recipient*
subject		 encounter requestedOn scheduled[x] sender requester
DeviceUseRequest identifier* status priority subject encounter orderedOn timing[x] recordedOn indication*
DeviceUseStatement identifier* subject whenUsed
timing[x]		 recordedOn device indication*
Encounter identifier* status class
type*		 priority patient episodeOfCare* period individual location reason*
indication*
EpisodeOfCare identifier* status type* condition* patient period
Flag identifier* status category code subject period
encounter		 author
Order identifier* subject schedule date target source reason[x]
OrderResponse identifier* date who
ProcessRequest
ProcessResponse
Schedule identifier* serviceType* actor planningHorizon
Slot identifier* specialty* start
end
SupplyDelivery
SupplyRequest
Task
Infrastructural Resources
AuditEvent type
subtype*
action
outcome
outcomeDesc
entity*
identifier
reference
type		 role
lifecycle
securityLabel*
name
description
query
detail*
type
value		 recorded source
site
identifier
type*		 agent*
role*
reference
userId
altId
name
requestor		 location
media
network
address
type		 purposeOfEvent*
policy*
purposeOfUse*
Basic identifier* code subject created author
Binary
Bundle type
Composition identifier status type
class
mode		 subject encounter date author* party
DocumentManifest masterIdentifier
identifier*		 status type subject created author* recipient*
DocumentReference masterIdentifier
identifier*		 status
docStatus		 type
class		 subject encounter created indexed author* authenticator
Linkage author
List identifier* status mode code subject encounter date source
Media identifier* type
subtype
view		 subject operator
MessageHeader event destination*
receiver		 timestamp enterer
author		 source responsible reason
OperationOutcome
Provenance target* period recorded actor
userId		 agent* location reason*
activity
Questionnaire url
identifier*		 version status date publisher
QuestionnaireResponse identifier status subject encounter authored author source
Subscription status contact* end reason
Conformance Resources
CodeSystem url
identifier		 version status experimental date publisher
CompartmentDefinition url status experimental date publisher requirements
ConceptMap url
identifier		 version status experimental date publisher
Conformance url version status experimental date publisher
DataElement url
identifier*		 version status experimental date publisher
ExpansionProfile url status
ImplementationGuide url version status experimental date publisher
NamingSystem value status kind date publisher
responsible
OperationDefinition url version status kind date publisher
SearchParameter url status experimental date publisher requirements
StructureDefinition url
identifier*		 version status experimental date publisher requirements
StructureMap url
identifier*		 version status experimental date publisher requirements
TestScript url
identifier		 version status experimental date publisher requirements
ValueSet url
identifier		 version status experimental lockedDate date publisher

Full

Resourceidid.versionstatusclassgradewhatwho.focuscontextwhen.initwhen.plannedwhen.donewhen.recordedwho.authorwho.sourcewho.actorwho.causewho.witnesswhowherewhy
Clinical Resources
AllergyIntolerance identifier* : Identifier status : code type : code
category : code		 criticality : code substance : CodeableConcept patient : Patient recordedDate : dateTime recorder : Practitioner|Patient reporter : Patient|RelatedPerson|Practitioner
BodySite
CarePlan status : code context : Encounter|EpisodeOfCare
CareTeam identifier* : Identifier status : CodeableConcept type* : CodeableConcept subject : Patient|Group period : Period member : Practitioner|RelatedPerson|Patient|Organization
ClinicalImpression status : code patient : Patient date : dateTime assessor : Practitioner
Condition identifier* : Identifier clinicalStatus : code
verificationStatus : code		 category : CodeableConcept severity : CodeableConcept code : CodeableConcept patient : Patient encounter : Encounter onset[x] : dateTime|Age|Period|Range|string abatement[x] : dateTime|Age|boolean|Period|Range|string dateRecorded : date asserter : Practitioner|Patient
DecisionSupportRule
DecisionSupportServiceModule
DetectedIssue identifier : Identifier category : CodeableConcept severity : code patient : Patient date : dateTime author : Practitioner|Device
DiagnosticOrder identifier* : Identifier status : code priority : code subject : Patient|Group|Location|Device encounter : Encounter orderer : Practitioner
DiagnosticReport identifier* : Identifier status : code category : CodeableConcept code : CodeableConcept subject : Patient|Group|Device|Location encounter : Encounter effective[x] : dateTime|Period issued : instant performer : Practitioner|Organization
FamilyMemberHistory identifier* : Identifier status : code patient : Patient date : dateTime
Goal identifier* : Identifier status : code subject : Patient|Group|Organization statusDate : date author : Patient|Practitioner|RelatedPerson
GuidanceResponse
ImagingExcerpt uid : oid patient : Patient authoringTime : dateTime author : Practitioner|Device|Organization|Patient|RelatedPerson
ImagingObjectSelection uid : oid patient : Patient authoringTime : dateTime author : Practitioner|Device|Organization|Patient|RelatedPerson
ImagingStudy uid : oid
accession : Identifier
identifier* : Identifier		 availability : code modalityList* : Coding patient : Patient started : dateTime order* : DiagnosticOrder
referrer : Practitioner		 interpreter : Practitioner
Immunization identifier* : Identifier status : code
wasNotGiven : boolean		 vaccineCode : CodeableConcept patient : Patient encounter : Encounter date : dateTime reported : boolean performer : Practitioner requester : Practitioner location : Location
ImmunizationRecommendation identifier* : Identifier patient : Patient
Library
Measure
MeasureReport
Medication code : CodeableConcept
isBrand : boolean		 manufacturer : Organization
MedicationAdministration identifier* : Identifier status : code medication[x] : CodeableConcept|Reference(Medication) patient : Patient encounter : Encounter effectiveTime[x] : dateTime|Period practitioner : Practitioner|Patient|RelatedPerson
MedicationDispense identifier : Identifier status : code medication[x] : CodeableConcept|Reference(Medication) patient : Patient dispenser : Practitioner
MedicationOrder identifier* : Identifier status : code medication[x] : CodeableConcept|Reference(Medication) patient : Patient encounter : Encounter dateWritten : dateTime prescriber : Practitioner reasonCode* : CodeableConcept
reasonReference* : Condition
MedicationStatement identifier* : Identifier status : code medication[x] : CodeableConcept|Reference(Medication) patient : Patient effective[x] : dateTime|Period informationSource : Patient|Practitioner|RelatedPerson
ModuleDefinition identifier* : Identifier
NutritionOrder identifier* : Identifier status : code type* : CodeableConcept
modifier : CodeableConcept
type : CodeableConcept
baseFormulaType : CodeableConcept
additiveType : CodeableConcept		 patient : Patient encounter : Encounter dateTime : dateTime orderer : Practitioner
Observation identifier* : Identifier status : code category : CodeableConcept code : CodeableConcept
code : CodeableConcept		 subject : Patient|Group|Device|Location encounter : Encounter effective[x] : dateTime|Period issued : instant performer* : Practitioner|Organization|Patient|RelatedPerson
OrderSet
Procedure identifier* : Identifier code : CodeableConcept subject : Patient|Group encounter : Encounter performed[x] : dateTime|Period actor : Practitioner|Organization|Patient|RelatedPerson location : Location
ProcedureRequest identifier* : Identifier status : code code : CodeableConcept priority : code subject : Patient|Group encounter : Encounter scheduled[x] : dateTime|Period|Timing orderedOn : dateTime orderer : Practitioner|Patient|RelatedPerson|Device performer : Practitioner|Organization|Patient|RelatedPerson
Protocol identifier* : Identifier
title : string		 status : code type : code subject : Condition|Device|Medication group : Group purpose : string author : Organization
ReferralRequest identifier* : Identifier status : code category : code
type : CodeableConcept		 priority : CodeableConcept serviceRequested* : CodeableConcept patient : Patient context : Encounter|EpisodeOfCare authored : dateTime fulfillmentTime : Period requester : Practitioner|Organization|Patient recipient* : Practitioner|Organization reason : CodeableConcept
RiskAssessment identifier : Identifier method : CodeableConcept subject : Patient|Group encounter : Encounter date : dateTime performer : Practitioner|Device
Sequence
Specimen identifier* : Identifier
accessionIdentifier : Identifier		 status : code type : CodeableConcept subject : Patient|Group|Device|Substance collected[x] : dateTime|Period receivedTime : dateTime collector : Practitioner
VisionPrescription
Administrative Resources
Device identifier* : Identifier
udiCarrier : Identifier		 status : code type : CodeableConcept
lotNumber : string
manufacturer : string
manufactureDate : dateTime
expirationDate : dateTime
model : string
version : string		 patient : Patient owner : Organization
contact* : ContactPoint		 location : Location
url : uri
DeviceComponent identifier : Identifier type : CodeableConcept lastSystemChange : instant
DeviceMetric identifier : Identifier type : CodeableConcept
category : code
Group identifier* : Identifier active : boolean type : code
actual : boolean		 code : CodeableConcept
HealthcareService identifier* : Identifier serviceCategory : CodeableConcept location* : Location
Location identifier* : Identifier status : code mode : code
type : CodeableConcept
physicalType : CodeableConcept
Organization identifier* : Identifier active : boolean type : CodeableConcept
Patient identifier* : Identifier active : boolean
Person identifier* : Identifier active : boolean
Practitioner identifier* : Identifier active : boolean period : Period location* : Location
PractitionerRole identifier* : Identifier active : boolean period : Period location* : Location
RelatedPerson identifier* : Identifier relationship : CodeableConcept period : Period
Substance identifier* : Identifier category* : CodeableConcept code : CodeableConcept
Workflow Resources
Appointment identifier* : Identifier status : code specialty* : CodeableConcept
priority : unsignedInt		 start : instant end : instant actor : Patient|Practitioner|RelatedPerson|Device|HealthcareService|Location
AppointmentResponse identifier* : Identifier start : instant end : instant actor : Patient|Practitioner|RelatedPerson|Device|HealthcareService|Location
Communication identifier* : Identifier status : code category : CodeableConcept recipient* : Device|Organization|Patient|Practitioner|RelatedPerson|Group
subject : Patient		 encounter : Encounter
requestDetail : CommunicationRequest		 sent : dateTime received : dateTime sender : Device|Organization|Patient|Practitioner|RelatedPerson
CommunicationRequest identifier* : Identifier status : code category : CodeableConcept recipient* : Device|Organization|Patient|Practitioner|RelatedPerson
subject : Patient		 encounter : Encounter requestedOn : dateTime scheduled[x] : dateTime|Period sender : Device|Organization|Patient|Practitioner|RelatedPerson requester : Practitioner|Patient|RelatedPerson
DeviceUseRequest identifier* : Identifier status : code priority : code subject : Patient encounter : Encounter orderedOn : dateTime timing[x] : Timing|Period|dateTime recordedOn : dateTime indication* : CodeableConcept
DeviceUseStatement identifier* : Identifier subject : Patient whenUsed : Period
timing[x] : Timing|Period|dateTime		 recordedOn : dateTime device : Device indication* : CodeableConcept
Encounter identifier* : Identifier status : code class : code
type* : CodeableConcept		 priority : CodeableConcept patient : Patient episodeOfCare* : EpisodeOfCare period : Period individual : Practitioner|RelatedPerson location : Location reason* : CodeableConcept
indication* : Condition|Procedure
EpisodeOfCare identifier* : Identifier status : code type* : CodeableConcept condition* : Condition patient : Patient period : Period
Flag identifier* : Identifier status : code category : CodeableConcept code : CodeableConcept subject : Patient|Location|Group|Organization|Practitioner period : Period
encounter : Encounter		 author : Device|Organization|Patient|Practitioner
Order identifier* : Identifier subject : Patient|Group|Device|Substance schedule : Timing date : dateTime target : Organization|Device|Practitioner source : Practitioner|Organization reason[x] : CodeableConcept|Reference(Any)
OrderResponse identifier* : Identifier date : dateTime who : Practitioner|Organization|Device
ProcessRequest
ProcessResponse
Schedule identifier* : Identifier serviceType* : CodeableConcept actor : Patient|Practitioner|RelatedPerson|Device|HealthcareService|Location planningHorizon : Period
Slot identifier* : Identifier specialty* : CodeableConcept start : instant
end : instant
SupplyDelivery
SupplyRequest
Task
Infrastructural Resources
AuditEvent type : Coding
subtype* : Coding
action : code
outcome : code
outcomeDesc : string
entity* :
identifier : Identifier
reference : Any
type : Coding		 role : Coding
lifecycle : Coding
securityLabel* : Coding
name : string
description : string
query : base64Binary
detail* :
type : string
value : base64Binary		 recorded : instant source :
site : string
identifier : Identifier
type* : Coding		 agent* :
role* : CodeableConcept
reference : Practitioner|Organization|Device|Patient|RelatedPerson
userId : Identifier
altId : string
name : string
requestor : boolean		 location : Location
media : Coding
network :
address : string
type : code		 purposeOfEvent* : Coding
policy* : uri
purposeOfUse* : Coding
Basic identifier* : Identifier code : CodeableConcept subject : Any created : date author : Practitioner|Patient|RelatedPerson
Binary
Bundle type : code
Composition identifier : Identifier status : code type : CodeableConcept
class : CodeableConcept
mode : code		 subject : Any encounter : Encounter date : dateTime author* : Practitioner|Device|Patient|RelatedPerson party : Patient|Practitioner|Organization
DocumentManifest masterIdentifier : Identifier
identifier* : Identifier		 status : code type : CodeableConcept subject : Patient|Practitioner|Group|Device created : dateTime author* : Practitioner|Organization|Device|Patient|RelatedPerson recipient* : Patient|Practitioner|RelatedPerson|Organization
DocumentReference masterIdentifier : Identifier
identifier* : Identifier		 status : code
docStatus : CodeableConcept		 type : CodeableConcept
class : CodeableConcept		 subject : Patient|Practitioner|Group|Device encounter : Encounter created : dateTime indexed : instant author* : Practitioner|Organization|Device|Patient|RelatedPerson authenticator : Practitioner|Organization
Linkage author : Practitioner|Organization
List identifier* : Identifier status : code mode : code code : CodeableConcept subject : Patient|Group|Device|Location encounter : Encounter date : dateTime source : Practitioner|Patient|Device
Media identifier* : Identifier type : code
subtype : CodeableConcept
view : CodeableConcept		 subject : Patient|Practitioner|Group|Device|Specimen operator : Practitioner
MessageHeader event : Coding destination* :
receiver : Practitioner|Organization		 timestamp : instant enterer : Practitioner
author : Practitioner		 source : responsible : Practitioner|Organization reason : CodeableConcept
OperationOutcome
Provenance target* : Any period : Period recorded : instant actor : Practitioner|RelatedPerson|Patient|Device|Organization
userId : Identifier		 agent* : location : Location reason* : Coding
activity : Coding
Questionnaire url : uri
identifier* : Identifier		 version : string status : code date : dateTime publisher : string
QuestionnaireResponse identifier : Identifier status : code subject : Any encounter : Encounter authored : dateTime author : Device|Practitioner|Patient|RelatedPerson source : Patient|Practitioner|RelatedPerson
Subscription status : code contact* : ContactPoint end : instant reason : string
Conformance Resources
CodeSystem url : uri
identifier : Identifier		 version : string status : code experimental : boolean date : dateTime publisher : string
CompartmentDefinition url : uri status : code experimental : boolean date : dateTime publisher : string requirements : string
ConceptMap url : uri
identifier : Identifier		 version : string status : code experimental : boolean date : dateTime publisher : string
Conformance url : uri version : string status : code experimental : boolean date : dateTime publisher : string
DataElement url : uri
identifier* : Identifier		 version : string status : code experimental : boolean date : dateTime publisher : string
ExpansionProfile url : uri status : code
ImplementationGuide url : uri version : string status : code experimental : boolean date : dateTime publisher : string
NamingSystem value : string status : code kind : code date : dateTime publisher : string
responsible : string
OperationDefinition url : uri version : string status : code kind : code date : dateTime publisher : string
SearchParameter url : uri status : code experimental : boolean date : dateTime publisher : string requirements : string
StructureDefinition url : uri
identifier* : Identifier		 version : string status : code experimental : boolean date : dateTime publisher : string requirements : string
StructureMap url : uri
identifier* : Identifier		 version : string status : code experimental : boolean date : dateTime publisher : string requirements : string
TestScript url : uri
identifier : Identifier		 version : string status : code experimental : boolean date : dateTime publisher : string requirements : string
ValueSet url : uri
identifier : Identifier		 version : string status : code experimental : boolean lockedDate : date date : dateTime publisher : string