Base FHIR Capability Statement (Full)

This is the base Capability Statement for FHIR. It represents a server that provides the full set of functionality defined by FHIR. It is provided to use as a template for system designers to build their own Capability Statements from

Mode SERVER
Description All the functionality defined in FHIR
Transaction y
System History y
System Search y
Resource Type Profile Read V-Read Search Update Updates Create Delete History
Account http://hl7.org/fhir/StructureDefinition/Account y y y y y y y y
ActivityDefinition http://hl7.org/fhir/StructureDefinition/ActivityDefinition y y y y y y y y
AdverseEvent http://hl7.org/fhir/StructureDefinition/AdverseEvent y y y y y y y y
AllergyIntolerance http://hl7.org/fhir/StructureDefinition/AllergyIntolerance y y y y y y y y
Appointment http://hl7.org/fhir/StructureDefinition/Appointment y y y y y y y y
AppointmentResponse http://hl7.org/fhir/StructureDefinition/AppointmentResponse y y y y y y y y
AuditEvent http://hl7.org/fhir/StructureDefinition/AuditEvent y y y y y y y y
Basic http://hl7.org/fhir/StructureDefinition/Basic y y y y y y y y
Binary http://hl7.org/fhir/StructureDefinition/Binary y y y y y y y y
BodySite http://hl7.org/fhir/StructureDefinition/BodySite y y y y y y y y
Bundle http://hl7.org/fhir/StructureDefinition/Bundle y y y y y y y y
CapabilityStatement http://hl7.org/fhir/StructureDefinition/CapabilityStatement y y y y y y y y
CarePlan http://hl7.org/fhir/StructureDefinition/CarePlan y y y y y y y y
CareTeam http://hl7.org/fhir/StructureDefinition/CareTeam y y y y y y y y
ChargeItem http://hl7.org/fhir/StructureDefinition/ChargeItem y y y y y y y y
Claim http://hl7.org/fhir/StructureDefinition/Claim y y y y y y y y
ClaimResponse http://hl7.org/fhir/StructureDefinition/ClaimResponse y y y y y y y y
ClinicalImpression http://hl7.org/fhir/StructureDefinition/ClinicalImpression y y y y y y y y
CodeSystem http://hl7.org/fhir/StructureDefinition/CodeSystem y y y y y y y y
Communication http://hl7.org/fhir/StructureDefinition/Communication y y y y y y y y
CommunicationRequest http://hl7.org/fhir/StructureDefinition/CommunicationRequest y y y y y y y y
CompartmentDefinition http://hl7.org/fhir/StructureDefinition/CompartmentDefinition y y y y y y y y
Composition http://hl7.org/fhir/StructureDefinition/Composition y y y y y y y y
ConceptMap http://hl7.org/fhir/StructureDefinition/ConceptMap y y y y y y y y
Condition http://hl7.org/fhir/StructureDefinition/Condition y y y y y y y y
Consent http://hl7.org/fhir/StructureDefinition/Consent y y y y y y y y
Contract http://hl7.org/fhir/StructureDefinition/Contract y y y y y y y y
Coverage http://hl7.org/fhir/StructureDefinition/Coverage y y y y y y y y
DataElement http://hl7.org/fhir/StructureDefinition/DataElement y y y y y y y y
DetectedIssue http://hl7.org/fhir/StructureDefinition/DetectedIssue y y y y y y y y
Device http://hl7.org/fhir/StructureDefinition/Device y y y y y y y y
DeviceComponent http://hl7.org/fhir/StructureDefinition/DeviceComponent y y y y y y y y
DeviceMetric http://hl7.org/fhir/StructureDefinition/DeviceMetric y y y y y y y y
DeviceRequest http://hl7.org/fhir/StructureDefinition/DeviceRequest y y y y y y y y
DeviceUseStatement http://hl7.org/fhir/StructureDefinition/DeviceUseStatement y y y y y y y y
DiagnosticReport http://hl7.org/fhir/StructureDefinition/DiagnosticReport y y y y y y y y
DocumentManifest http://hl7.org/fhir/StructureDefinition/DocumentManifest y y y y y y y y
DocumentReference http://hl7.org/fhir/StructureDefinition/DocumentReference y y y y y y y y
EligibilityRequest http://hl7.org/fhir/StructureDefinition/EligibilityRequest y y y y y y y y
EligibilityResponse http://hl7.org/fhir/StructureDefinition/EligibilityResponse y y y y y y y y
Encounter http://hl7.org/fhir/StructureDefinition/Encounter y y y y y y y y
Endpoint http://hl7.org/fhir/StructureDefinition/Endpoint y y y y y y y y
EnrollmentRequest http://hl7.org/fhir/StructureDefinition/EnrollmentRequest y y y y y y y y
EnrollmentResponse http://hl7.org/fhir/StructureDefinition/EnrollmentResponse y y y y y y y y
EpisodeOfCare http://hl7.org/fhir/StructureDefinition/EpisodeOfCare y y y y y y y y
ExpansionProfile http://hl7.org/fhir/StructureDefinition/ExpansionProfile y y y y y y y y
ExplanationOfBenefit http://hl7.org/fhir/StructureDefinition/ExplanationOfBenefit y y y y y y y y
FamilyMemberHistory http://hl7.org/fhir/StructureDefinition/FamilyMemberHistory y y y y y y y y
Flag http://hl7.org/fhir/StructureDefinition/Flag y y y y y y y y
Goal http://hl7.org/fhir/StructureDefinition/Goal y y y y y y y y
GraphDefinition http://hl7.org/fhir/StructureDefinition/GraphDefinition y y y y y y y y
Group http://hl7.org/fhir/StructureDefinition/Group y y y y y y y y
GuidanceResponse http://hl7.org/fhir/StructureDefinition/GuidanceResponse y y y y y y y y
HealthcareService http://hl7.org/fhir/StructureDefinition/HealthcareService y y y y y y y y
ImagingManifest http://hl7.org/fhir/StructureDefinition/ImagingManifest y y y y y y y y
ImagingStudy http://hl7.org/fhir/StructureDefinition/ImagingStudy y y y y y y y y
Immunization http://hl7.org/fhir/StructureDefinition/Immunization y y y y y y y y
ImmunizationRecommendation http://hl7.org/fhir/StructureDefinition/ImmunizationRecommendation y y y y y y y y
ImplementationGuide http://hl7.org/fhir/StructureDefinition/ImplementationGuide y y y y y y y y
Library http://hl7.org/fhir/StructureDefinition/Library y y y y y y y y
Linkage http://hl7.org/fhir/StructureDefinition/Linkage y y y y y y y y
List http://hl7.org/fhir/StructureDefinition/List y y y y y y y y
Location http://hl7.org/fhir/StructureDefinition/Location y y y y y y y y
Measure http://hl7.org/fhir/StructureDefinition/Measure y y y y y y y y
MeasureReport http://hl7.org/fhir/StructureDefinition/MeasureReport y y y y y y y y
Media http://hl7.org/fhir/StructureDefinition/Media y y y y y y y y
Medication http://hl7.org/fhir/StructureDefinition/Medication y y y y y y y y
MedicationAdministration http://hl7.org/fhir/StructureDefinition/MedicationAdministration y y y y y y y y
MedicationDispense http://hl7.org/fhir/StructureDefinition/MedicationDispense y y y y y y y y
MedicationRequest http://hl7.org/fhir/StructureDefinition/MedicationRequest y y y y y y y y
MedicationStatement http://hl7.org/fhir/StructureDefinition/MedicationStatement y y y y y y y y
MessageDefinition http://hl7.org/fhir/StructureDefinition/MessageDefinition y y y y y y y y
MessageHeader http://hl7.org/fhir/StructureDefinition/MessageHeader y y y y y y y y
NamingSystem http://hl7.org/fhir/StructureDefinition/NamingSystem y y y y y y y y
NutritionOrder http://hl7.org/fhir/StructureDefinition/NutritionOrder y y y y y y y y
Observation http://hl7.org/fhir/StructureDefinition/Observation y y y y y y y y
OperationDefinition http://hl7.org/fhir/StructureDefinition/OperationDefinition y y y y y y y y
OperationOutcome http://hl7.org/fhir/StructureDefinition/OperationOutcome y y y y y y y y
Organization http://hl7.org/fhir/StructureDefinition/Organization y y y y y y y y
Patient http://hl7.org/fhir/StructureDefinition/Patient y y y y y y y y
PaymentNotice http://hl7.org/fhir/StructureDefinition/PaymentNotice y y y y y y y y
PaymentReconciliation http://hl7.org/fhir/StructureDefinition/PaymentReconciliation y y y y y y y y
Person http://hl7.org/fhir/StructureDefinition/Person y y y y y y y y
PlanDefinition http://hl7.org/fhir/StructureDefinition/PlanDefinition y y y y y y y y
Practitioner http://hl7.org/fhir/StructureDefinition/Practitioner y y y y y y y y
PractitionerRole http://hl7.org/fhir/StructureDefinition/PractitionerRole y y y y y y y y
Procedure http://hl7.org/fhir/StructureDefinition/Procedure y y y y y y y y
ProcedureRequest http://hl7.org/fhir/StructureDefinition/ProcedureRequest y y y y y y y y
ProcessRequest http://hl7.org/fhir/StructureDefinition/ProcessRequest y y y y y y y y
ProcessResponse http://hl7.org/fhir/StructureDefinition/ProcessResponse y y y y y y y y
Provenance http://hl7.org/fhir/StructureDefinition/Provenance y y y y y y y y
Questionnaire http://hl7.org/fhir/StructureDefinition/Questionnaire y y y y y y y y
QuestionnaireResponse http://hl7.org/fhir/StructureDefinition/QuestionnaireResponse y y y y y y y y
ReferralRequest http://hl7.org/fhir/StructureDefinition/ReferralRequest y y y y y y y y
RelatedPerson http://hl7.org/fhir/StructureDefinition/RelatedPerson y y y y y y y y
RequestGroup http://hl7.org/fhir/StructureDefinition/RequestGroup y y y y y y y y
ResearchStudy http://hl7.org/fhir/StructureDefinition/ResearchStudy y y y y y y y y
ResearchSubject http://hl7.org/fhir/StructureDefinition/ResearchSubject y y y y y y y y
RiskAssessment http://hl7.org/fhir/StructureDefinition/RiskAssessment y y y y y y y y
Schedule http://hl7.org/fhir/StructureDefinition/Schedule y y y y y y y y
SearchParameter http://hl7.org/fhir/StructureDefinition/SearchParameter y y y y y y y y
Sequence http://hl7.org/fhir/StructureDefinition/Sequence y y y y y y y y
ServiceDefinition http://hl7.org/fhir/StructureDefinition/ServiceDefinition y y y y y y y y
Slot http://hl7.org/fhir/StructureDefinition/Slot y y y y y y y y
Specimen http://hl7.org/fhir/StructureDefinition/Specimen y y y y y y y y
StructureDefinition http://hl7.org/fhir/StructureDefinition/StructureDefinition y y y y y y y y
StructureMap http://hl7.org/fhir/StructureDefinition/StructureMap y y y y y y y y
Subscription http://hl7.org/fhir/StructureDefinition/Subscription y y y y y y y y
Substance http://hl7.org/fhir/StructureDefinition/Substance y y y y y y y y
SupplyDelivery http://hl7.org/fhir/StructureDefinition/SupplyDelivery y y y y y y y y
SupplyRequest http://hl7.org/fhir/StructureDefinition/SupplyRequest y y y y y y y y
Task http://hl7.org/fhir/StructureDefinition/Task y y y y y y y y
TestReport http://hl7.org/fhir/StructureDefinition/TestReport y y y y y y y y
TestScript http://hl7.org/fhir/StructureDefinition/TestScript y y y y y y y y
ValueSet http://hl7.org/fhir/StructureDefinition/ValueSet y y y y y y y y
VisionPrescription http://hl7.org/fhir/StructureDefinition/VisionPrescription y y y y y y y y

Base FHIR Capability Statement (Empty)

This is the base Capability Statement for FHIR. It represents a server that provides the none of the functionality defined by FHIR. It is provided to use as a template for system designers to build their own Capability Statements from. A capability statement has to contain something, so this contains a read of a Capability Statement

Mode SERVER
Description An empty Capability Statement
Transaction
System History
System Search
Resource Type Profile Read V-Read Search Update Updates Create Delete History
CapabilityStatement y

The following resources may be in this compartment:

Resource Inclusion Criteria
Account subject
Appointment actor
AppointmentResponse actor
AuditEvent agent
ChargeItem enterer, participant-actor
Communication sender, recipient
CommunicationRequest sender, recipient
Composition author
DetectedIssue author
Device {def}
DeviceComponent source
DeviceMetric source
DeviceRequest device, subject, requester, performer
DeviceUseStatement device
DiagnosticReport subject
DocumentManifest subject, author
DocumentReference subject, author
Flag author
Group member
ImagingManifest author
List subject, source
Media subject
MedicationAdministration device
MessageHeader target
Observation subject, device
ProcedureRequest performer, requester
Provenance agent
QuestionnaireResponse author
RequestGroup author
RiskAssessment performer
Schedule actor
Specimen subject
SupplyRequest requester

A resource is in this compartment if the nominated search parameter (or chain) refers to the patient resource that defines the compartment.

The following resources are never in this compartment:

The following resources may be in this compartment:

Resource Inclusion Criteria
ChargeItem context
Claim encounter
ClinicalImpression context
Communication context
CommunicationRequest context
Composition encounter
Condition context
DeviceRequest encounter
DiagnosticReport encounter
DocumentReference encounter
Encounter {def}
ExplanationOfBenefit encounter
MedicationAdministration context
MedicationRequest context
NutritionOrder encounter
Observation encounter
Procedure encounter
ProcedureRequest context
QuestionnaireResponse context
RequestGroup encounter
VisionPrescription encounter

A resource is in this compartment if the nominated search parameter (or chain) refers to the patient resource that defines the compartment.

The following resources are never in this compartment:

The following resources may be in this compartment:

Resource Inclusion Criteria
Account subject
AdverseEvent subject
AllergyIntolerance patient, recorder, asserter
Appointment actor
AppointmentResponse actor
AuditEvent patient, agent.patient, entity.patient
Basic patient, author
BodySite patient
CarePlan patient, performer
CareTeam patient, participant
ChargeItem subject
Claim patient, payee
ClaimResponse patient
ClinicalImpression subject
Communication subject, sender, recipient
CommunicationRequest subject, sender, recipient, requester
Composition subject, author, attester
Condition patient, asserter
Consent patient
Coverage policy-holder, subscriber, beneficiary, payor
DetectedIssue patient
DeviceRequest subject, requester, performer
DeviceUseStatement subject
DiagnosticReport subject
DocumentManifest subject, author, recipient
DocumentReference subject, author
EligibilityRequest patient
Encounter patient
EnrollmentRequest subject
EpisodeOfCare patient
ExplanationOfBenefit patient, payee
FamilyMemberHistory patient
Flag patient
Goal patient
Group member
ImagingManifest patient, author
ImagingStudy patient
Immunization patient
ImmunizationRecommendation patient
List subject, source
MeasureReport patient
Media subject
MedicationAdministration patient, performer, subject
MedicationDispense subject, patient, receiver
MedicationRequest subject
MedicationStatement subject
NutritionOrder patient
Observation subject, performer
Patient link
Person patient
Procedure patient, performer
ProcedureRequest subject, performer
Provenance target.subject, target.patient, patient
QuestionnaireResponse subject, author
ReferralRequest patient, requester
RelatedPerson patient
RequestGroup subject, participant
ResearchSubject individual
RiskAssessment subject
Schedule actor
Specimen subject
SupplyDelivery patient
SupplyRequest requester
VisionPrescription patient

A resource is in this compartment if the nominated search parameter (or chain) refers to the patient resource that defines the compartment.

The following resources are never in this compartment:

The following resources may be in this compartment:

Resource Inclusion Criteria
Account subject
AdverseEvent recorder
AllergyIntolerance recorder, asserter
Appointment actor
AppointmentResponse actor
AuditEvent agent
Basic author
CarePlan performer
CareTeam participant
ChargeItem enterer, participant-actor
Claim enterer, provider, payee, care-team
ClaimResponse request-provider
ClinicalImpression assessor
Communication sender, recipient
CommunicationRequest sender, recipient, requester
Composition subject, author, attester
Condition asserter
DetectedIssue author
DeviceRequest requester, performer
DiagnosticReport performer
DocumentManifest subject, author, recipient
DocumentReference subject, author, authenticator
EligibilityRequest enterer, provider
EligibilityResponse request-provider
Encounter practitioner, participant
EpisodeOfCare care-manager
ExplanationOfBenefit enterer, provider, payee, care-team
Flag author
Group member
ImagingManifest author
Immunization practitioner
Linkage author
List source
Media subject, operator
MedicationAdministration performer
MedicationDispense performer, receiver
MedicationRequest requester
MedicationStatement source
MessageHeader receiver, author, responsible, enterer
NutritionOrder provider
Observation performer
Patient general-practitioner
PaymentNotice provider
PaymentReconciliation request-provider
Person practitioner
Practitioner {def}
PractitionerRole practitioner
Procedure performer
ProcedureRequest performer, requester
ProcessRequest provider
ProcessResponse request-provider
Provenance agent
QuestionnaireResponse author, source
ReferralRequest requester, recipient
RequestGroup participant, author
ResearchStudy principalinvestigator
RiskAssessment performer
Schedule actor
Specimen collector
SupplyDelivery supplier, receiver
SupplyRequest requester
VisionPrescription prescriber

A resource is in this compartment if the nominated search parameter (or chain) refers to the patient resource that defines the compartment.

The following resources are never in this compartment:

The following resources may be in this compartment:

Resource Inclusion Criteria
AdverseEvent recorder
AllergyIntolerance asserter
Appointment actor
AppointmentResponse actor
Basic author
CarePlan performer
CareTeam participant
ChargeItem enterer, participant-actor
Claim payee
Communication sender, recipient
CommunicationRequest sender, recipient, requester
Composition author
Condition asserter
Coverage policy-holder, subscriber, payor
DocumentManifest author
DocumentReference author
Encounter participant
ExplanationOfBenefit payee
ImagingManifest author
MedicationAdministration performer
MedicationStatement source
Observation performer
Patient link
Person link
Procedure performer
ProcedureRequest performer
Provenance agent
QuestionnaireResponse author, source
RelatedPerson {def}
RequestGroup participant
Schedule actor
SupplyRequest requester

A resource is in this compartment if the nominated search parameter (or chain) refers to the patient resource that defines the compartment.

The following resources are never in this compartment:

Apply

OPERATION: Apply

The official URL for this operation definition is: 

http://hl7.org/fhir/OperationDefinition/ActivityDefinition-apply

The apply operation realizes a definition in a specific context

URL: [base]/ActivityDefinition/[id]/$apply

Parameters

Use Name Cardinality Type Binding Documentation
IN patient 1..1 Reference

The patient that is the target of the activity to be applied
IN encounter 0..1 Reference

The encounter in context, if any
IN practitioner 0..1 Reference

The practitioner in context
IN organization 0..1 Reference

The organization in context
IN userType 0..1 CodeableConcept

The type of user initiating the request, e.g. patient, healthcare provider, or specific type of healthcare provider (physician, nurse, etc.)
IN userLanguage 0..1 CodeableConcept

Preferred language of the person using the system
IN userTaskContext 0..1 CodeableConcept

The task the system user is performing, e.g. laboratory results review, medication list review, etc. This information can be used to tailor decision support outputs, such as recommended information resources
IN setting 0..1 CodeableConcept

The current setting of the request (inpatient, outpatient, etc)
IN settingContext 0..1 CodeableConcept

Additional detail about the setting of the request, if any
OUT return 1..1 Any

The resource that is the result of applying the definition

The result of invoking this operation is a resource of the type specified by the activity definition, with all the definitions resolved as appropriate for the type of resource. Any dynamicValue elements will be evaluated and the resulting value used for the values of the appropriate elements of the returned resource. If the ActivityDefinition includes library references, those libraries will be available to the evaluated expressions. If those libraries have parameters, those parameters will be bound by name to the parameters given to the operation

Data Requirements

OPERATION: Data Requirements

The official URL for this operation definition is: 

http://hl7.org/fhir/OperationDefinition/ActivityDefinition-data-requirements

The data-requirements operation aggregates and returns the parameters and data requirements for the activity definition and all its dependencies as a single module definition library

URL: [base]/ActivityDefinition/[id]/$data-requirements

Parameters

Use Name Cardinality Type Binding Documentation
OUT return 1..1 Library

The result of the requirements gathering represented as a module-definition Library that describes the aggregate parameters, data requirements, and dependencies of the activity definition

The effect of invoking this operation is to determine the aggregate set of data requirements and dependencies for the activity definition. The result is a Library resource with a type of module-definition that contains all the parameter definitions and data requirements of the activity definition and any libraries referenced by it. Implementations SHOULD aggregate data requirements intelligently (i.e. by collapsing overlapping data requirements)

Test if a server implements a client's required operations

OPERATION: Test if a server implements a client's required operations

The official URL for this operation definition is: 

http://hl7.org/fhir/OperationDefinition/CapabilityStatement-conforms

This operation asks the server to check that it implements all the resources, interactions, search parameters, and operations that the client provides in its capability statement. The client provides both capability statements by reference, and must ensure that all the referenced resources are available to the conformance server

URL: [base]/CapabilityStatement/$conforms

Parameters

Use Name Cardinality Type Binding Documentation
IN left 0..1 uri

The canonical URL for the left-hand system's capability statement
IN right 0..1 uri

The canonical URL for the right-hand system's capability statement
IN mode 0..1 code

What kind of comparison to perform - server to server, or client to server (use the codes 'server/server' or 'client/server')
OUT issues 1..1 OperationOutcome

Outcome of the CapabilityStatement test
OUT union 0..1 CapabilityStatement

The intersection of the functionality described by the CapabilityStatement resources
OUT intersection 0..1 CapabilityStatement

The union of the functionality described by the CapabilityStatement resources

The operation performs a full comparison of the functionality described by the two capability statements, including the profiles and value sets they reference, and also including concept maps and structure maps.

The full execution of this operation is still a matter of research, but it is intended to support comparison of systems to see if they will interoperate

If the capability statements can be successfully compared, then the return value is a 200 OK with an OperationOutcome along with intersection and union capability statements. The operation outcome can contain errors relating to differences between the capability statements. If the capability statements cannot be compared, because dependencies cannot be located, the return value is a 4xx error, with an OperationOutcome with at least one issue with severity >= error

Test if a server implements a client's required operations

OPERATION: Test if a server implements a client's required operations

The official URL for this operation definition is: 

http://hl7.org/fhir/OperationDefinition/CapabilityStatement-implements

This operation asks the server to check that it implements all the resources, interactions, search parameters, and operations that the client provides in its capability statement. The client provides its capability statement inline, or by referring the server to the canonical URL of its capability statement

URL: [base]/CapabilityStatement/$implements

URL: [base]/CapabilityStatement/[id]/$implements

Parameters

Use Name Cardinality Type Binding Documentation
IN server 0..1 uri

The canonical URL for the server capability statement - use this if the implements is not invoked on an instance (or on the /metadata end-point)
IN client 0..1 uri

The canonical URL for the client capability statement - use this if the implements is not invoked on an instance (or on the /metadata end-point)
IN resource 0..1 CapabilityStatement

The client capability statement, provided inline
OUT return 1..1 OperationOutcome

Outcome of the CapabilityStatement test

The operation does not perform a full conformance check; in particular it does not check that the profiles align. It merely checks that the behaviors the client wishes to use are provided

Technically, this operation is implemented as follows: * The server's capability statement must have an entry for each resource in the client's capability statement * The servers' resource support must have matching flags for updateCreate, conditionalCreate, conditionalRead, conditionalUpdate, conditionalDelete, searchInclude, searchRevInclude * The server capability statement must have a matching interaction for each interaction in the client capability statement (whether or not it is on a resource) * The server must have a search parameter with matching name and definition for any search parameters in the client capability statement * The server must have an operation definitions with a matching reference for any operations in the client capability statement

If the capability statements match by these rules, then the return value is a 200 OK with an operation outcome that contains no issues with severity >= error. If the capability statement doesn't match, the return value is a 4xx error, with an OperationOutcome with at least one issue with severity >= error

Fetch a subset of the CapabilityStatement resource

OPERATION: Fetch a subset of the CapabilityStatement resource

The official URL for this operation definition is: 

http://hl7.org/fhir/OperationDefinition/CapabilityStatement-subset

This operation asks the server to return a subset of the CapabilityStatement resource - just the REST parts that relate to a set of nominated resources - the resources that the client is interested in

URL: [base]/CapabilityStatement/$subset

URL: [base]/CapabilityStatement/[id]/$subset

Parameters

Use Name Cardinality Type Binding Documentation
IN server 0..1 uri

The canonical URL - use this if the subset is not invoked on an instance (or on the /metadata end-point)
IN resource 1..* code

A resource that the client would like to include in the return
OUT return 1..1 CapabilityStatement

The subsetted CapabilityStatement resource that is returned. This should be tagged with the SUBSETTED code

Code Composition based on supplied properties

OPERATION: Code Composition based on supplied properties

The official URL for this operation definition is: 

http://hl7.org/fhir/OperationDefinition/CodeSystem-compose

Given a set of properties, return one or more possible matching codes

This operation takes a set of properties, and examines the code system looking for codes in the code system that match a set of known properties.

When looking for matches, there are 3 possible types of match: * a complete match - a code that represents all the provided properties correctly * a partial match - a code that represents some of the provided properties correctly, and not others * a possible match - a code that may represent the provided properties closely, but may capture less or more precise informationfor some of the properties

The $compose operation can be called in one of 2 modes: * By a human, looking for the best match for a set of properties. In this mode, the server returns a list of complete, possible or partial matches (possibly with comments), so that the user can choose (or not) the most appropriate code * By a machine (typically in a system interface performing a transformation). In this mode, the server returns only a list of complete and partial matches, but no possible matches. The machine can choose a code from the list (or not) based on what properties are not coded

These modes are differentiated by the 'exact' parameter, so the client can indicate whether it only wants exact matches (including partial matches) or whether potential matches based on text matching are desired

The compose operation is still preliminary. The interface can be expected to change as more experience is gained from implementations.

URL: [base]/CodeSystem/$compose

URL: [base]/CodeSystem/[id]/$compose

Parameters

Use Name Cardinality Type Binding Documentation
IN system 0..1 uri

The system in which composition is to be performed. This must be provided unless the operation is invoked on a code system instance
IN version 0..1 string

The version of the system for the inferencing to be performed
IN property 0..*

One or more properties that contain information to be composed into the code
IN property.code 1..1 code

Identifies the property provided
IN property.value 0..1 code

The value of the property provided
IN property.subproperty 0..*

Nested Properties (mainly used for SNOMED CT composition, for relationship Groups)
IN property.subproperty.code 1..1 code

Identifies the sub-property provided
IN property.subproperty.value 1..1 code

The value of the sub-property provided
IN exact 1..1 boolean

Whether the operation is being used by a human, or a machine. If the operation is being used by a human, the terminology server can return a list of possible matches, with commentary. For a machine, the server returns sure matches, or none at all
IN compositional 0..1 boolean

Post-coordinated expressions are allowed to be returned in the matching codes (mainly for SNOMED CT). Default = false
OUT match 0..*

Concepts returned by the server as a result of the inferencing operation
OUT match.code 1..1 Coding

A code that matches the properties provided
OUT match.unmatched 0..*

One or more properties that contain properties that could not be matched into the code
OUT match.unmatched.code 1..1 code

Identifies the property provided
OUT match.unmatched.value 1..1 code

The value of the property provided
OUT match.unmatched.property 0..*

Nested Properties (mainly used for SNOMED CT composition, for relationship Groups)
OUT match.unmatched.property.code 1..1 code

Identifies the sub-property provided
OUT match.unmatched.property.value 1..1 code

The value of the sub-property provided
OUT match.comment 0..1 string

Information about the quality of the match, if operation is for a human

Concept Look Up & Decomposition

OPERATION: Concept Look Up & Decomposition

The official URL for this operation definition is: 

http://hl7.org/fhir/OperationDefinition/CodeSystem-lookup

Given a code/system, or a Coding, get additional details about the concept, including definition, status, designations, and properties. One of the products of this operation is a full decomposition of a code from a structure terminology

URL: [base]/CodeSystem/$lookup

Parameters

Use Name Cardinality Type Binding Documentation
IN code 0..1 code

The code that is to be located. If a code is provided, a system must be provided
IN system 0..1 uri

The system for the code that is to be located
IN version 0..1 string

The version of the system, if one was provided in the source data
IN coding 0..1 Coding

A coding to look up
IN date 0..1 dateTime

The date for which the information should be returned. Normally, this is the current conditions (which is the default value) but under some circumstances, systems need to acccess this information as it would have been in the past. A typical example of this would be where code selection is constrained to the set of codes that were available when the patient was treated, not when the record is being edited. Note that which date is appropriate is a matter for implementation policy.
IN displayLanguage 0..1 code

The requested language for display (see ExpansionProfile.displayLanguage)
IN property 0..* code

A property that the client wishes to be returned in the output. If no properties are specified, the server chooses what to return. The following properties are defined for all code systems: url, name, version (code system info) and code information: display, definition, designation, parent and child, and for designations, lang.X where X is a designation language code. Some of the properties are returned explicit in named parameters (when the names match), and the rest (except for lang.X) in the property parameter group
OUT name 1..1 string

A display name for the code system
OUT version 0..1 string

The version that these details are based on
OUT display 1..1 string

The preferred display for this concept
OUT designation 0..*

Additional representations for this concept
OUT designation.language 0..1 code

The language this designation is defined for
OUT designation.use 0..1 Coding

A code that details how this designation would be used
OUT designation.value 1..1 string

The text value for this designation
OUT property 0..*

One or more properties that contain additional information about the code, including status. For complex terminologies (e.g. SNOMED CT, LOINC, medications), these properties serve to decompose the code
OUT property.code 1..1 code

Identifies the property returned
OUT property.value 0..1 code

The value of the property returned
OUT property.description 0..1 string

Human Readable representation of the property value (e.g. display for a code)
OUT property.subproperty 0..*

Nested Properties (mainly used for SNOMED CT decomposition, for relationship Groups)
OUT property.subproperty.code 1..1 code

Identifies the sub-property returned
OUT property.subproperty.value 1..1 code

The value of the sub-property returned
OUT property.subproperty.description 0..1 string

Human Readable representation of the property value (e.g. display for a code)

Note that the $lookup operation is more than just a code system search - the server finds the concept, and gathers the return information from the underlying code system definitions.

Subsumption Testing

OPERATION: Subsumption Testing

The official URL for this operation definition is: 

http://hl7.org/fhir/OperationDefinition/CodeSystem-subsumes

Test the subsumption relationship between code/Coding A and code/Coding B given the semantics of subsumption in the underlying code system (see hierarchyMeaning)

URL: [base]/CodeSystem/$subsumes

URL: [base]/CodeSystem/[id]/$subsumes

Parameters

Use Name Cardinality Type Binding Documentation
IN codeA 0..1 code

The "A" code that is to be tested. If a code is provided, a system must be provided
IN codeB 0..1 code

The "B" code that is to be tested. If a code is provided, a system must be provided
IN system 0..1 uri

The code system in which subsumption testing is to be performed. This must be provided unless the operation is invoked on a code system instance
IN version 0..1 string

The version of the code system, if one was provided in the source data
IN codingA 0..1 Coding

The "A" Coding that is to be tested. The code system does not have to match the specified subsumption code system, but the relationships between the code systems must be well established
IN codingB 0..1 Coding

The "B" Coding that is to be tested. The code system does not have to match the specified subsumption code system, but the relationships between the code systems must be well established
OUT outcome 1..1 code

The subsumption relationship between code/Coding "A" and code/Coding "B". There are 4 possible codes to be returned: equivalent, subsumes, subsumed-by, and not-subsumed. If the server is unable to determine the relationship between the codes/Codings, then it returns an error (i.e. an OperationOutcome)

Generate a Document

OPERATION: Generate a Document

The official URL for this operation definition is: 

http://hl7.org/fhir/OperationDefinition/Composition-document

A client can ask a server to generate a fully bundled document from a composition resource. The server takes the composition resource, locates all the referenced resources and other additional resources as configured or requested and either returns a full document bundle, or returns an error. Note that since this is a search operation, the document bundle is wrapped inside the search bundle. If some of the resources are located on other servers, it is at the discretion of the server whether to retrieve them or return an error. If the correct version of the document that would be generated already exists, then the server can return the existing one.

URL: [base]/Composition/$document

URL: [base]/Composition/[id]/$document

Parameters

Use Name Cardinality Type Binding Documentation
IN persist 0..1 boolean

Whether to store the document at the bundle end-point (/Bundle) or not once it is generated. Value = true or false (default is for the server to decide). If the document is stored, it's location can be inferred from the Bundle.id, but it SHOULD be provided explicitly in the HTTP Location header in the response

Note: this operation definition does not resolve the question how document signatures are created. This is an open issue during the period of trial use, and feedback is requested regarding this question

Closure Table Maintenance

OPERATION: Closure Table Maintenance

The official URL for this operation definition is: 

http://hl7.org/fhir/OperationDefinition/ConceptMap-closure

This operation provides support for ongoing maintenance of a client-side transitive closure table based on server-side terminological logic. For details of how this is used, see Maintaining a Closure Table

URL: [base]/$closure

Parameters

Use Name Cardinality Type Binding Documentation
IN name 1..1 string

The name that defines the particular context for the subsumption based closure table
IN concept 0..* Coding

Concepts to add to the closure table
IN version 0..1 id

A request to resynchronise - request to send all new entries since the nominated version was sent by the server
OUT return 1..1 ConceptMap

A list of new entries (code / system --> code/system) that the client should add to its closure table. The only kind of entry mapping equivalences that can be returned are equal, specializes, subsumes and unmatched

Concept Translation

OPERATION: Concept Translation

The official URL for this operation definition is: 

http://hl7.org/fhir/OperationDefinition/ConceptMap-translate

Translate a code from one value set to another, based on the existing value set and concept maps resources, and/or other additional knowledge available to the server.

One (and only one) of the in parameters (code, coding, codeableConcept) must be provided, to identify the code that is to be translated.

The operation returns a set of parameters including a 'result' for whether there is an acceptable match, and a list of possible matches. Note that the list of matches may include notes of codes for which mapping is specifically excluded, so implementers have to check the match.equivalence for each match

URL: [base]/ConceptMap/$translate

URL: [base]/ConceptMap/[id]/$translate

Parameters

Use Name Cardinality Type Binding Documentation
IN code 0..1 code

The code that is to be translated. If a code is provided, a system must be provided
IN system 0..1 uri

The system for the code that is to be translated
IN version 0..1 string

The version of the system, if one was provided in the source data
IN source 0..1 uri

Identifies the value set used when the concept (system/code pair) was chosen. May be a logical id, or an absolute or relative location. The source value set is an optional parameter because in some cases, the client cannot know what the source value set is. However, without a source value set, the server may be unable to safely identify an applicable concept map, and would return an error. For this reason, a source value set SHOULD always be provided. Note that servers may be able to identify an appropriate concept map without a source value set if there is a full mapping for the entire code system in the concept map, or by manual intervention
IN coding 0..1 Coding

A coding to translate
IN codeableConcept 0..1 CodeableConcept

A full codeableConcept to validate. The server can translate any of the coding values (e.g. existing translations) as it chooses
IN target 0..1 uri

Identifies the value set in which a translation is sought. May be a logical id, or an absolute or relative location. If there's no target specified, the server should return all known translations, along with their source
IN targetsystem 0..1 uri

identifies a target code system in which a mapping is sought. This parameter is an alternative to the target parameter - only one is required. Searching for any translation to a target code system irrespective of the context (e.g. target valueset) may lead to unsafe results, and it is at the discretion of the server to decide when to support this operation
IN dependency 0..*

Another element that may help produce the correct mapping
IN dependency.element 0..1 uri

The element for this dependency
IN dependency.concept 0..1 CodeableConcept

The value for this dependency
IN reverse 0..1 boolean

if this is true, then the operation should return all the codes that might be mapped to this code. This parameter reverses the meaning of the source and target parameters
OUT result 1..1 boolean

True if the concept could be translated successfully. The value can only be true if at least one returned match has an equivalence which is not unmatched or disjoint
OUT message 0..1 string

Error details, for display to a human. If this is provided when result = true, the message carries hints and warnings (e.g. a note that the matches could be improved by providing additional detail)
OUT match 0..*

A concept in the target value set with an equivalence. Note that there may be multiple matches of equal or differing equivalence, and the matches may include equivalence values that mean that there is no match
OUT match.equivalence 0..1 code

A code indicating the equivalence of the translation, using values from [ConceptMapEquivalence]{concept-map-equivalence.html}
OUT match.concept 0..1 Coding

The translation outcome. Note that this would never have userSelected = true, since the process of translations implies that the user is not selecting the code (and only the client could know differently)
OUT match.product 0..*

Another element that is the product of this mapping
OUT match.product.element 0..1 uri

The element for this product
OUT match.product.concept 0..1 Coding

The value for this product
OUT match.source 0..1 uri

The canonical URI for the concept map from which this mapping comes from

Fetch Encounter Record

OPERATION: Fetch Encounter Record

The official URL for this operation definition is: 

http://hl7.org/fhir/OperationDefinition/Encounter-everything

This operation is used to return all the information related to an encounter described in the resource on which this operation is invoked. The response is a bundle of type "searchset". At a minimum, the encounter resource itself is returned, along with any other resources that the server has available for the given encounter for the user. The server also returns whatever resources are needed to support the records - e.g. linked practitioners, locations, organizations etc. The principle intended use for this operation is to provide a patient with access to their record, or to allow a client to retrieve everything for an encounter for efficient display).

The server SHOULD return all resources it has that:

  • are included in the encounter compartment for the identified encounter (have a reference to the encounter)
  • are referenced by the standard extenstion for associating an encounter (where no reference element exists) http://hl7.org/fhir/StructureDefinition/encounter-associatedEncounter
  • the server believes are relevant to the context of the encounter for any other reason (internally defined/decided)
  • any resource referenced by the above, including binaries and attachments (to make a more complete package)

In the US Realm, at a mimimum, the resources returned SHALL include all the data covered by the meaningful use common data elements (see DAF for further guidance). Other applicable implementation guides may make additional rules about the information that is returned. Note that for many resources, the exact nature of the link to encounter can be ambiguous (e.g. for a DiagnosticReport, is it the encounter when it was initiated, or when it was reported?)

URL: [base]/Encounter/[id]/$everything

Parameters

Use Name Cardinality Type Binding Documentation
OUT return 1..1 Bundle

The bundle type is "searchset"

The key differences between this operation and simply searching the encounter compartment are: * unless the client requests otherwise, the server returns the entire result set in a single bundle (rather than using paging) * the server is responsible for determining what resources to return as included resources (rather than the client specifying which ones)

Data Requirements

OPERATION: Data Requirements

The official URL for this operation definition is: 

http://hl7.org/fhir/OperationDefinition/Library-data-requirements

The data-requirements operation aggregates and returns the parameters and data requirements for a resource and all its dependencies as a single module definition

URL: [base]/$data-requirements

URL: [base]/Library/[id]/$data-requirements

Parameters

Use Name Cardinality Type Binding Documentation
IN target 0..1 Reference

The target of the data requirements operation
OUT return 1..1 Library

The result of the requirements gathering

The effect of invoking this operation is to determine the aggregate set of data requirements and dependencies for a given target resource. The result is a Library resource with a type of module-definition that contains all the parameter definitions and data requirements of the target resource and any libraries referenced by it. Implementations SHOULD aggregate data requirements intelligently (i.e. by collapsing overlapping data requirements)

Find a functional list

OPERATION: Find a functional list

The official URL for this operation definition is: 

http://hl7.org/fhir/OperationDefinition/List-find

This operation allows a client to find an identified list for a particular function by its function. The operation takes two parameters, the identity of a patient, and the name of a functional list. The list of defined functional lists can be found at Current Resource Lists. Applications are not required to support all the lists, and may define additional lists of their own. If the system is able to locate a list that serves the identified purpose, it returns it as the body of the response with a 200 OK status. If the resource cannot be located, the server returns a 404 not found (optionally with an OperationOutcome resource)

URL: [base]/List/$find

Parameters

Use Name Cardinality Type Binding Documentation
IN patient 1..1 id

The id of a patient resource located on the server on which this operation is executed
IN name 1..1 code

The code for the functional list that is being found

Note that servers may support searching by a functional list, and not support this operation that allows clients to find the list directly

Data Requirements

OPERATION: Data Requirements

The official URL for this operation definition is: 

http://hl7.org/fhir/OperationDefinition/Measure-data-requirements

The data-requirements operation aggregates and returns the parameters and data requirements for the measure and all its dependencies as a single module definition

URL: [base]/Measure/[id]/$data-requirements

Parameters

Use Name Cardinality Type Binding Documentation
IN periodStart 1..1 date

The start of the measurement period. In keeping with the semantics of the date parameter used in the FHIR search operation, the period will start at the beginning of the period implied by the supplied timestamp. E.g. a value of 2014 would set the period start to be 2014-01-01T00:00:00 inclusive
IN periodEnd 1..1 date

The end of the measurement period. The period will end at the end of the period implied by the supplied timestamp. E.g. a value of 2014 would set the period end to be 2014-12-31T23:59:59 inclusive
OUT return 1..1 Library

The result of the requirements gathering is a module-definition Library that describes the aggregate parameters, data requirements, and dependencies of the measure

The effect of invoking this operation is to determine the aggregate set of data requirements and dependencies for the measure. The result is a Library resource with a type of module-definition that contains all the parameter definitions and data requirements of the libraries referenced by the measures. Implementations SHOULD aggregate data requirements intelligently (i.e. by collapsing overlapping data requirements)

Evaluate Measure

OPERATION: Evaluate Measure

The official URL for this operation definition is: 

http://hl7.org/fhir/OperationDefinition/Measure-evaluate-measure

The evaluate-measure operation is used to invoke an eMeasure and obtain the results

URL: [base]/Measure/$evaluate-measure

URL: [base]/Measure/[id]/$evaluate-measure

Parameters

Use Name Cardinality Type Binding Documentation
IN periodStart 1..1 date

The start of the measurement period. In keeping with the semantics of the date parameter used in the FHIR search operation, the period will start at the beginning of the period implied by the supplied timestamp. E.g. a value of 2014 would set the period start to be 2014-01-01T00:00:00 inclusive
IN periodEnd 1..1 date

The end of the measurement period. The period will end at the end of the period implied by the supplied timestamp. E.g. a value of 2014 would set the period end to be 2014-12-31T23:59:59 inclusive
IN measure 0..1 Reference

The measure to evaluate. This parameter is only required when the operation is invoked on the resource type, it is not used when invoking the operation on a Measure instance
IN reportType 0..1 code

The type of measure report, patient, patient-list, or population. If not specified, a default value of patient will be used if the patient parameter is supplied, otherwise, population will be used
IN patient 0..1 Reference

Patient to evaluate against. If not specified, the measure will be evaluated for all patients that meet the requirements of the measure. If specified, only the referenced patient will be evaluated
IN practitioner 0..1 Reference

Practitioner to evaluate. If specified, the measure will be evaluated only for patients whose primary practitioner is the identified practitioner
IN lastReceivedOn 0..1 dateTime

The date the results of this measure were last received. This parameter is only valid for patient-level reports and is used to indicate when the last time a result for this patient was received. This information can be used to limit the set of resources returned for a patient-level report
OUT return 1..1 MeasureReport

The results of the measure calculation. See the MeasureReport resource for a complete description of the output of this operation

The effect of invoking this operation is to calculate the measure for the given patient, or all patients if no patient is supplied, and return the results as a MeasureReport resource of the appropriate type

Process Message

OPERATION: Process Message

The official URL for this operation definition is: 

http://hl7.org/fhir/OperationDefinition/MessageHeader-process-message

This operation accepts a message, processes it according to the definition of the event in the message header, and returns a one or more response messages. This operation is described in detail on the messaging page

URL: [base]/$process-message

Parameters

Use Name Cardinality Type Binding Documentation
IN content 1..1 Bundle

The message to process (or, if using asynchronous messaging, it may be a response message to accept)
IN async 0..1 boolean

If 'true' the message is processed using the asynchronous messaging pattern
IN response-url 0..1 uri

A URL to submit response messages to, if asynchronous messaging is being used, and if the MessageHeader.source.endpoint is not the appropriate place to submit responses
OUT return 0..1 Bundle

A response message, if synchronous messaging is being used (mandatory in this case). For asynchronous messaging, there is no return value

This operation does not use the parameters resource; the parameters "async" and "response-url" always go in the URL, if they are used, and the message parameter is always the body of the HTTP message

Last N Observations Query

OPERATION: Last N Observations Query

The official URL for this operation definition is: 

http://hl7.org/fhir/OperationDefinition/Observation-lastn

The lastn query meets the common need for searching for the most recent or last n=number of observations for a subject. For example, retrieving the last 5 temperatures for a patient to view trends or fetching the most recent laboratory results or vitals signs. To ask a server to return the last n=number of observations, the lastn queryuses the normal search parameters defined for the Observation resource. However, rather than their normal use, they are interpreted as inputs - i.e.. instead of requiring that the resources literally contain the search parameters, they are passed to a server algorithm of some kind that uses them to determine the most appropriate matches.

The response from an lastn query is a set of observations:

  • filtered by additional parameters
  • 'GROUP BY' Observation.code
  • sorted from most recent to the oldest
  • limited to the number of requested responses per group specified by the optional max query parameter
  • If no maximum number is given then only the most recent Observation in each group is returned.

The set of returned observations should represent distinct real world observations and not the same observation with changes in status or versions. If there are no matches, the lastn query SHALL return an empty search set with no error, but may include an operation outcome with further advice.

URL: [base]/Observation/$lastn

Parameters

Use Name Cardinality Type Binding Documentation
IN max 0..1 positiveInt

max is an optional input parameter to the lastn query operation. It is used to specify the maximum number of Observations to return from each group. For example for the query "Fetch the last 3 results for all vitals for a patient" max = 3.
OUT return 1..1 Bundle

The set of most recent N Observations that match the lastn query search criteria.

The key differences between this query operation and simply searching Observation using the combination of _count and _sort parameters are:

  • The lastn query returns only the last N resource grouped by code. Using the _count query method doesn't restrict the total mathches so you may need to page through several "A" Observations before getting to Observation "B".
  • The server is responsible for grouping the observations by codes. This frees the client from needing to determine which codes she should ask for.

This operation cannot be performed on observations that the user is not authorized to see. It is assumed that the server has identified and secured the context appropriately, and can either associate the authorization context with a single patient, or determine whether the context has the rights to the nominated patient, if there is one. If there is no nominated patient (e.g. the operation is invoked at the system level) and the context is not associated with a single patient record, then the server should return an error. Specifying the relationship between the context, a user and patient records is outside the scope of this specification.

Observation Statistics

OPERATION: Observation Statistics

The official URL for this operation definition is: 

http://hl7.org/fhir/OperationDefinition/Observation-stats

The Statistics operation performs a set of statistical calculations on a set of clinical measurements such as a blood pressure as stored on the server. This operation is focused on Observation resources with valueQuantity elements that have UCUM unit codes.

The set of Observations is defined by 4 parameters:

  • the subject of the observations for which the statistics are being generated (subject)
  • which observations to generate statistics for (code and system, or coding)
  • the time period over which to generate statistics 'duration or period)
  • the set of statistical analyses to return (statistic)

Possible statistical analyses (see StatisticsCode):

  • average ("Average"): The mean of N measurements over the stated period
  • maximum ("Maximum"): The maximum value of N measurements over the stated period
  • minimum ("Minimum"): The minimum value of N measurements over the stated period
  • count ("Count"): The [number] of valid measurements over the stated period that contributed to the other statistical outputs
  • totalcount ("Total Count"): The total [number] of valid measurements over the stated period, including observations that were ignored because they did not contain valid result values
  • median ("Median"): The median of N measurements over the stated period
  • std-dev ("Standard Deviation"): The standard deviation of N measurements over the stated period
  • sum ("Sum"): The sum of N measurements over the stated period
  • variance ("Variance"): The variance of N measurements over the stated period
  • 20-percent ("20th Percentile"): The 20th Percentile of N measurements over the stated period
  • 80-percent ("80th Percentile"): The 80th Percentile of N measurements over the stated period
  • 4-lower ("Lower Quartile"): The lower Quartile Boundary of N measurements over the stated period
  • 4-upper ("Upper Quartile"): The upper Quartile Boundary of N measurements over the stated period
  • 4-dev ("Quartile Deviation"): The difference between the upper and lower Quartiles is called the Interquartile range. (IQR = Q3-Q1) Quartile deviation or Semi-interquartile range is one-half the difference between the first and the third quartiles.
  • 5-1 ("1st Quintile"): The lowest of four values that divide the N measurements into a frequency distribution of five classes with each containing one fifth of the total population
  • 5-2 ("2nd Quintile"): The second of four values that divide the N measurements into a frequency distribution of five classes with each containing one fifth of the total population
  • 5-3 ("3rd Quintile"): The third of four values that divide the N measurements into a frequency distribution of five classes with each containing one fifth of the total population
  • 5-4 ("4th Quintile"): The fourth of four values that divide the N measurements into a frequency distribution of five classes with each containing one fifth of the total population
  • skew ("Skew"): Skewness is a measure of the asymmetry of the probability distribution of a real-valued random variable about its mean. The skewness value can be positive or negative, or even undefined. Source: Wikipedia
  • kurtosis ("Kurtosis"): Kurtosis is a measure of the "tailedness" of the probability distribution of a real-valued random variable. Source: Wikipedia
  • regression ("Regression"): Linear regression is an approach for modeling two-dimensional sample points with one independent variable and one dependent variable (conventionally, the x and y coordinates in a Cartesian coordinate system) and finds a linear function (a non-vertical straight line) that, as accurately as possible, predicts the dependent variable values as a function of the independent variables. Source: Wikipedia This Statistic code will return both a gradient and an intercept value.

If successful, the operation returns an Observation resource for each code with the results of the statistical calculations as component value pairs where the component code = the statistical code. The Observation also contains the input parameters patient,code and duration parameters. If unsuccessful, an OperationOutcome with an error message will be returned.

The client can request that all the observations on which the statistics are based be returned as well, using the include parameter. If an include parameter is specified, a limit may also be specified; the sources observations are subsetted at the server's discretion if count > limit. This functionality is included with the intent of supporting graphical presentation

URL: [base]/Observation/$stats

Parameters

Use Name Cardinality Type Binding Documentation
IN subject 1..1 uri

The subject of the relevant Observations, which has the value of the Observation.subject.reference. E.g. 'Patient/123'. Reference can be to an absolute URL, but servers only perform stats on their own observations
IN code 0..* string

The test code(s) upon which the statistics are being performed. Provide along with a system, or as a coding. For example, the code = "45667-2" will evaluate all relevant Observations with this code in Observation.code. For LOINC codes that are panels, (e.g. 55284-4) this means to include all the individual codes that are part of a panel
IN system 0..1 uri

The system for the code(s). Or provide a coding instead
IN coding 0..* Coding

The test code upon which the statistics are being performed, as a Coding
IN duration 0..1 decimal

The time period of interest given as hours. For example, the duration = "1" represents the last hour - the time period from on hour ago to now
IN period 0..1 Period

The time period over which the calculations to be performed, if a duration is not provided
IN statistic 1..* code

average|max|min|count The statistical operations to be performed on the relevant operations. Multiple statistics operations can be specified. These codes are defined here
IN include 0..1 boolean

Whether to return the observations on which the statistics are based
IN limit 0..1 positiveInt

If an include parameter is specified, a limit may also be specified to limit the number of source Observations returned. If the include paramter is absent or equal to "false" the limit parameter SHALL be ignored by the server
OUT return 1..* Observation

A set of observations, one observation for each code, each containing one component for each statistic. The Observation.component.code contains the statistic, and is relative to the Observation.code and cannot be interpreted independently. The Observation will also contain a subject, effectivePeriod, and code reflecting the input parameters. The status is fixed to final.
OUT source 0..* Observation

Source observations on which the statistics are based

This operation cannot be performed on observations that the user is not authorized to see. It is assumed that the server has identified and secured the context appropriately, and can either associate the authorization context with a single patient, or determine whether the context has the rights to the nominated patient, if there is one. If there is no nominated patient (e.g. the operation is invoked at the system level) and the context is not associated with a single patient record, then the server should return an error. Specifying the relationship between the context, a user and patient records is outside the scope of this specification.

Fetch Patient Record

OPERATION: Fetch Patient Record

The official URL for this operation definition is: 

http://hl7.org/fhir/OperationDefinition/Patient-everything

This operation is used to return all the information related to the patient described in the resource on which this operation is invoked. The response is a bundle of type "searchset". At a minimum, the patient resource itself is returned, along with any other resources that the server has that are related to the patient, and that are available for the given user. The server also returns whatever resources are needed to support the records - e.g. linked practitioners, medications, locations, organizations etc. The principle intended use for this operation is to provide a patient with access to their entire record (e.g. "Blue Button"). The server SHOULD return at least all resources that it has that are in the patient compartment for the identified patient, and any resource referenced from those, including binaries and attachments. In the US Realm, at a mimimum, the resources returned SHALL include all the data covered by the meaningful use common data elements as defined in DAF. Other applicable implementation guides may make additional rules about how much information that is returned

URL: [base]/Patient/$everything

URL: [base]/Patient/[id]/$everything

Parameters

Use Name Cardinality Type Binding Documentation
IN start 0..1 date

The date range relates to care dates, not record currency dates - e.g. all records relating to care provided in a certain date range. If no start date is provided, all records prior to the end date are in scope.
IN end 0..1 date

The date range relates to care dates, not record currency dates - e.g. all records relating to care provided in a certain date range. If no end date is provided, all records subsequent to the start date are in scope.
OUT return 1..1 Bundle

The bundle type is "searchset"

The key differences between this operation and simply searching the patient compartment are:

  • unless the client requests otherwise, the server returns the entire result set in a single bundle (rather than using paging)
  • the server is responsible for determining what resources to return as included resources (rather than the client specifying which ones). This frees the client from needing to determine what it could or should ask for

It is assumed that the server has identified and secured the context appropriately, and can either associate the authorization context with a single patient, or determine whether the context has the rights to the nominated patient, if there is one. If there is no nominated patient (e.g. the operation is invoked at the system level) and the context is not associated with a single patient record, then the server should return an error. Specifying the relationship between the context, a user and patient records is outside the scope of this specification.

Find patient matches using MPI based logic

OPERATION: Find patient matches using MPI based logic

The official URL for this operation definition is: 

http://hl7.org/fhir/OperationDefinition/Patient-match

A Master Patient Index (MPI ) is a service used to manage patient identification in a context where multiple patient databases exist. Healthcare applications and middleware use the MPI to match patients between the databases, and as new patient details are encountered. MPIs are highly specialized applications, often tailored extensively to the institution's particular mix of patients. MPIs can also be run on a regional and national basis.\n\nTo ask an MPI to match a patient, clients use the \"$match\" operation, which accepts a patient resource which may be only partially complete. The data provided is interpreted as an MPI input and passed processed by an algorithm of some kind that uses the data to determine the most appropriate matches in the patient set. \n\nNote that different MPI matching algorithms have different required inputs. The generic $match operation does not specify any particular algorithm, nor a minimum set of information that must be provided when asking for an MPI match operation to be performed, but may implementations will have a set of minimum information, which may be declared in their definition of the $match operation by specifying a profile on the resource parameter, indicating which properties are required in the search.\n\nThe patient resource coming into the operation does not have to be complete, nor does it need to pass validation (i.e. Mandatory fields don't need to be populated), but it does have to be a valid instance. This is due to the resource being used for reference data to match from, and not being stored.

URL: [base]/Patient/$match

Parameters

Use Name Cardinality Type Binding Documentation
IN resource 1..1 Resource

Use this to provide an entire set of patient details for the MPI to match against (e.g. POST a patient record to Patient/$match). If a patient record is not provided, then one or more of the other parameters must be provided
IN onlyCertainMatches 0..1 boolean

If there are multiple potential matches, then the match should not return the results with this flag set to true.

When false, the server may return multiple results with each result graded accordingly.
IN count 0..1 integer

The maximum number of records to return. If no value is provided, the server decides how many matches to return. Note that clients should be careful when using this, as it may prevent probable - and valid - matches from being returned
OUT return 1..1 Bundle

A bundle contain a set of Patient records that represent possible matches, optionally it may also contain an OperationOutcome with further information about the search results (such as warnings or information messages, such as a count of records that were close but eliminated)

If the operation was unsuccessful, then an OperationOutcome may be returned along with a BadRequest status Code (e.g. security issue, or insufficient properties in patient fragment - check against profile)

The response from an "mpi" query is a bundle containing patient records, ordered from most likely to least likely. If there are no patient matches, the MPI SHALL return an empty search set with no error, but may include an operation outcome with further advice regarding patient selection. All patient records SHALL have a search score from 0 to 1, where 1 is the most certain match, along with an extension "match-grade" that indicates the MPI's position on the match quality.

Apply

OPERATION: Apply

The official URL for this operation definition is: 

http://hl7.org/fhir/OperationDefinition/PlanDefinition-apply

The apply operation applies a PlanDefinition to a given context

URL: [base]/PlanDefinition/[id]/$apply

Parameters

Use Name Cardinality Type Binding Documentation
IN patient 1..1 Reference

The patient that is the target of the plan to be applied
IN encounter 0..1 Reference

The encounter in context, if any
IN practitioner 0..1 Reference

The practitioner applying the plan definition
IN organization 0..1 Reference

The organization applying the plan definition
IN userType 0..1 CodeableConcept

The type of user initiating the request, e.g. patient, healthcare provider, or specific type of healthcare provider (physician, nurse, etc.)
IN userLanguage 0..1 CodeableConcept

Preferred language of the person using the system
IN userTaskContext 0..1 CodeableConcept

The task the system user is performing, e.g. laboratory results review, medication list review, etc. This information can be used to tailor decision support outputs, such as recommended information resources
IN setting 0..1 CodeableConcept

The current setting of the request (inpatient, outpatient, etc)
IN settingContext 0..1 CodeableConcept

Additional detail about the setting of the request, if any
OUT return 1..1 CarePlan

The CarePlan that is the result of applying the plan definition

The result of this operation is a CarePlan resource, with activities for each of the applicable actions based on evaluating the applicability condition in context. For each applicable action, the activitydefinition is applied as described in the $apply operation of the ActivityDefinition resource, and the resulting resource is added as an activity to the CarePlan. If the ActivityDefinition includes library references, those libraries will be available to the evaluated expressions. If those libraries have parameters, those parameters will be bound by name to the parameters given to the operation

Data Requirements

OPERATION: Data Requirements

The official URL for this operation definition is: 

http://hl7.org/fhir/OperationDefinition/PlanDefinition-data-requirements

The data-requirements operation aggregates and returns the parameters and data requirements for the plan definition and all its dependencies as a single module definition library

URL: [base]/PlanDefinition/[id]/$data-requirements

Parameters

Use Name Cardinality Type Binding Documentation
OUT return 1..1 Library

The result of the requirements gathering is a module-definition Library that describes the aggregate parameters, data requirements, and dependencies of the plan definition

The effect of invoking this operation is to determine the aggregate set of data requirements and dependencies for the plan definition. The result is a Library resource with a type of module-definition that contains all the parameter definitions and data requirements of the plan definition and any libraries referenced by it. Implementations SHOULD aggregate data requirements intelligently (i.e. by collapsing overlapping data requirements)

Populate Questionnaire

OPERATION: Populate Questionnaire

The official URL for this operation definition is: 

http://hl7.org/fhir/OperationDefinition/Questionnaire-populate

Generates a QuestionnaireResponse instance based on a specified Questionnaire, filling in answers to questions where possible based on information provided as part of the operation or already known by the server about the subject of the Questionnaire.

If the operation is not called at the instance level, one and only one of the identifier, questionnaire or questionnaireRef 'in' parameters must be provided. If called at the instance level, these parameters will be ignored.

The response will contain a QuestionnaireResponse instance based on the specified Questionnaire and/or an OperationOutcome resource with errors or warnings.

The QuestionnaireResponse instance will be populated with an unanswered set of questions following the group and question structure of the specified Questionnaire. If content parameters were specified or the local parameter was set to true, some of the questions may have answers filled in as well. In the case of repeating questions or groups, typically only one repetition will be provided unless answer values exist that would support populating multiple repetitions.

Population of the QuestionnaireResponse with appropriate data is dependent on the questions and/or groups in the Questionnaire having metadata that allows the server to recognize the questions, e.g. through Questionnaire.item.definition or through use of the ConceptMap resource.

Regardless of the mechanism used to link the questions in a questionnaire to a "known" mappable concept, solutions using this operation should ensure that the details of the question and associated linkage element are sufficiently similar as to safely allow auto-population; i.e. the question text and context must be sufficiently the same, the value set for the question must fall within the value set for the mapped element, the data types must be the same or convertible, etc.

URL: [base]/Questionnaire/$populate

URL: [base]/Questionnaire/[id]/$populate

Parameters

Use Name Cardinality Type Binding Documentation
IN identifier 0..1 uri

A logical questionnaire identifier (i.e. ''Questionnaire.identifier''). The server must know the questionnaire or be able to retrieve it from other known repositories.
IN questionnaire 0..1 Questionnaire

The Questionnaire is provided directly as part of the request. Servers may choose not to accept questionnaires in this fashion
IN questionnaireRef 0..1 Reference

The Questionnaire is provided as a resource reference. Servers may choose not to accept questionnaires in this fashion or may fail if they cannot resolve or access the referenced questionnaire.
IN subject 1..1 Reference

The resource that is to be the QuestionnaireResponse.subject. The QuestionnaireResponse instance will reference the provided subject. In addition, if the local parameter is set to true, server information about the specified subject will be used to populate the instance.
IN content 0..* Reference

Resources containing information to be used to help populate the QuestionnaireResponse. These may be FHIR resources or may be binaries containing FHIR documents, CDA documents or other source materials. Servers may not support all possible source materials and may ignore materials they do not recognize. (They MAY provide warnings if ignoring submitted resources.)
IN local 0..1 boolean

If specified and set to 'true' (and the server is capable), the server should use what resources and other knowledge it has about the referenced subject when pre-populating answers to questions.
OUT questionnaire 1..1 QuestionnaireResponse

The partially (or fully)-populated set of answers for the specified Questionnaire
OUT issues 0..1 OperationOutcome

A list of hints and warnings about problems encountered while populating the questionnaire. These might be show to the user as an advisory note. Note: if the questionnaire cannot be populated at all, then the operation should fail, and an OperationOutcome is returned directly with the failure, rather than using this parameter

While it is theoretically possible for a QuestionnaireResponse instance to be completely auto-populated and submitted without human review, the intention of this transaction is merely to reduce redundant data entry. A client SHOULD ensure that a human submitter has an opportunity to review the auto-populated answers to confirm correctness as well as to complete or expand on information provided by the auto-population process.

When creating an "empty" questionnaire, the general algorithm is to create a QuestionnaireResponse with one item for every item in the source Questionnaire, including items with "enableWhen", "display" items, etc. If a question has a default, the default answer should be populated. And the QuestionnaireResponse should point back to the originating Questionnaire. Repeating items will typically only include a single repetition. Other extensions and/or elements may also be populated if the system is aware of appropriate values.

Complex form designs with conditional logic or tight constraints on cardinalities may be challenging to auto-populate. A server MAY choose to traverse the questionnaire as if it were a human respondent, answering only those questions that are enabled based on previously answered questions. However, doing so may result in minimal population. Alternatively, systems may choose to populate all known answers, independent of dependencies and other constraints. This may cause questions to be answered that should not be answered. It will be up to the client to appropriately prune the final populated questionnaire once human review has taken place.

Invoking this operation with the ''content'' parameter may involve the disclosure of personally identifiable healthcare information to the system which is performing the population process. No such disclosures should be made unless the system on which the operation is being invoked is a "trusted" system and appropriate agreements are in place to protect the confidentiality of any information shared with that system.

Generate HTML for Questionnaire

OPERATION: Generate HTML for Questionnaire

The official URL for this operation definition is: 

http://hl7.org/fhir/OperationDefinition/Questionnaire-populatehtml

Generates an HTML page as a Binary instance based on a specified Questionnaire, filling in answers to questions where possible based on information provided as part of the operation or already known by the server about the subject of the Questionnaire.

If the operation is not called at the instance level, one and only one of the identifier, questionnaire or questionnaireRef 'in' parameters must be provided. If called at the instance level, these parameters will be ignored.

The response will contain a Binary instance containing an HTML page for filling in and submitting the specified Questionnaire and/or an OperationOutcome resource with errors or warnings.

The generated HTML form instance will be populated with an unanswered set of questions following the group and question structure of the specified Questionnaire. If content parameters were specified or the local parameter was set to true, some of the questions may have answers filled in as well. In the case of repeating questions or groups, typically only one repetition will be provided unless answer values exist that would support populating multiple repetitions.

Population of the HTML form with appropriate data is dependent on the questions and/or groups in the Questionnaire having metadata that allows the server to recognize the questions, e.g. through Questionnaire.item.definition or through use of the ConceptMap resource.

Regardless of the mechanism used to link the questions in a questionnaire to a "known" mappable concept, solutions using this operation should ensure that the details of the question and associated linkage element are sufficiently similar as to safely allow auto-population; i.e. the question text and context must be sufficiently the same, the value set for the question must fall within the value set for the mapped element, the data types must be the same or convertible, etc.

URL: [base]/Questionnaire/$populatehtml

URL: [base]/Questionnaire/[id]/$populatehtml

Parameters

Use Name Cardinality Type Binding Documentation
IN identifier 0..1 uri

A logical questionnaire identifier (i.e. ''Questionnaire.identifier''). The server must know the questionnaire or be able to retrieve it from other known repositories.
IN questionnaire 0..1 Questionnaire

The Questionnaire is provided directly as part of the request. Servers may choose not to accept questionnaires in this fashion
IN questionnaireRef 0..1 Reference

The Questionnaire is provided as a resource reference. Servers may choose not to accept questionnaires in this fashion or may fail if they cannot resolve or access the referenced questionnaire.
IN content 0..* Reference

Resources containing information to be used to help populate the generated HTML form. These may be FHIR resources or may be binaries containing FHIR documents, CDA documents or other source materials. Servers may not support all possible source materials and may ignore materials they do not recognize. (They MAY provide warnings if ignoring submitted resources.)
IN local 0..1 boolean

If specified and set to 'true' (and the server is capable), the server should use what resources and other knowledge it has about the referenced subject when pre-populating answers to questions.
OUT form 1..1 Binary

The generated HTML page that supports capturing the information defined by questionnaire, possibly partially (or fully)-populated with a set of answers for the specified Questionnaire
OUT issues 0..1 OperationOutcome

A list of hints and warnings about problems encountered while populating the questionnaire. These might be show to the user as an advisory note. Note: if the questionnaire cannot be populated at all, then the operation should fail, and an OperationOutcome is returned directly with the failure, rather than using this parameter

While it is theoretically possible for an HTML form to be completely auto-populated and submitted without human review, the intention of this transaction is merely to reduce redundant data entry. The HTML form SHOULD ensure that a human submitter has an opportunity to review the auto-populated answers to confirm correctness as well as to complete or expand on information provided by the auto-population process.

Complex form designs with conditional logic or tight constraints on cardinalities may be challenging to auto-populate. A server MAY choose to traverse the questionnaire as if it were a human respondent, answering only those questions that are enabled based on previously answered questions. However, doing so may result in minimal population. Alternatively, systems may choose to populate all known answers, independent of dependencies and other constraints. This may cause questions to be answered that should not be answered. The generated HTML form is responsible for pruning the final populated questionnaire once human review has taken place.

Invoking this operation with the ''content'' parameter may involve the disclosure of personally identifiable healthcare information to the system which is performing the population process. No such disclosures should be made unless the system on which the operation is being invoked is a "trusted" system and appropriate agreements are in place to protect the confidentiality of any information shared with that system.

Generate a link to a Questionnaire completion webpage

OPERATION: Generate a link to a Questionnaire completion webpage

The official URL for this operation definition is: 

http://hl7.org/fhir/OperationDefinition/Questionnaire-populatelink

Generates a link to a web page to be used to answer a specified Questionnaire. The form at the specified location will be pre-filled with answers to questions where possible based on information provided as part of the operation or already known by the server about the subject of the Questionnaire.

If the operation is not called at the instance level, one and only one of the identifier, questionnaire or questionnaireRef 'in' parameters must be provided. If called at the instance level, these parameters will be ignored.

The response will contain a url for the web page to direct the user to. The page will allow the user to complete/verify the questionnaire answers and to submit the form.

The specified page will be populated with an unanswered set of questions following the group and question structure of the specified Questionnaire. If content parameters were specified or the local parameter was set to true, some of the questions may have answers filled in as well. In the case of repeating questions or groups, typically only one repetition will be provided unless answer values exist that would support populating multiple repetitions.

Population of the page with appropriate data is dependent on the questions and/or groups in the Questionnaire having metadata that allows the server to recognize the questions, e.g. through Questionnaire.item.definition or through use of the ConceptMap resource.

Regardless of the mechanism used to link the questions in a questionnaire to a "known" mappable concept, solutions using this operation should ensure that the details of the question and associated linkage element are sufficiently similar as to safely allow auto-population; i.e. the question text and context must be sufficiently the same, the value set for the question must fall within the value set for the mapped element, the data types must be the same or convertible, etc.

URL: [base]/Questionnaire/$populatelink

URL: [base]/Questionnaire/[id]/$populatelink

Parameters

Use Name Cardinality Type Binding Documentation
IN identifier 0..1 uri

A logical questionnaire identifier (i.e. ''Questionnaire.identifier''). The server must know the questionnaire or be able to retrieve it from other known repositories.
IN questionnaire 0..1 Questionnaire

The Questionnaire is provided directly as part of the request. Servers may choose not to accept questionnaires in this fashion
IN questionnaireRef 0..1 Reference

The Questionnaire is provided as a resource reference. Servers may choose not to accept questionnaires in this fashion or may fail if they cannot resolve or access the referenced questionnaire.
IN content 0..* Reference

Resources containing information to be used to help populate the generated HTML form. These may be FHIR resources or may be binaries containing FHIR documents, CDA documents or other source materials. Servers may not support all possible source materials and may ignore materials they do not recognize. (They MAY provide warnings if ignoring submitted resources.)
IN local 0..1 boolean

If specified and set to 'true' (and the server is capable), the server should use what resources and other knowledge it has about the referenced subject when pre-populating answers to questions.
OUT link 1..1 uri

The URL for the web form that supports capturing the information defined by questionnaire, possibly partially (or fully)-populated with a set of answers for the specified Questionnaire
OUT issues 0..1 OperationOutcome

A list of hints and warnings about problems encountered while populating the questionnaire. These might be show to the user as an advisory note. Note: if the questionnaire cannot be populated at all, then the operation should fail, and an OperationOutcome is returned directly with the failure, rather than using this parameter

While it is theoretically possible for the questionnaire response to be completely auto-populated and submitted without human review, the intention of this transaction is merely to reduce redundant data entry. The web page SHOULD ensure that a human submitter has an opportunity to review the auto-populated answers to confirm correctness as well as to complete or expand on information provided by the auto-population process.

Complex form designs with conditional logic or tight constraints on cardinalities may be challenging to auto-populate. A server MAY choose to traverse the questionnaire as if it were a human respondent, answering only those questions that are enabled based on previously answered questions. However, doing so may result in minimal population. Alternatively, systems may choose to populate all known answers, independent of dependencies and other constraints. This may cause questions to be answered that should not be answered. The web form is responsible for pruning the final populated questionnaire once human review has taken place.

Invoking this operation with the ''content'' parameter may involve the disclosure of personally identifiable healthcare information to the system which is performing the population process. No such disclosures should be made unless the system on which the operation is being invoked is a "trusted" system and appropriate agreements are in place to protect the confidentiality of any information shared with that system.

Access a list of profiles, tags, and security labels

OPERATION: Access a list of profiles, tags, and security labels

The official URL for this operation definition is: 

http://hl7.org/fhir/OperationDefinition/Resource-meta

This operation retrieves a summary of the profiles, tags, and security labels for the given scope; e.g. for each scope:

  • system-wide: a list of all profiles, tags and security labels in use by the system
  • resource-type level: A list of all profiles, tags, and security labels for the resource type
  • individual resource level: A list of all profiles, tags, and security labels for the current version of the resource. Also, as a special case, this operation (and other meta operations) can be performed on a historical version of a resource)

URL: [base]/$meta

URL: [base]/Resource/$meta

URL: [base]/Resource/[id]/$meta

Parameters

Use Name Cardinality Type Binding Documentation
OUT return 1..1 Meta

The meta returned by the operation

At the system and type levels, the $meta operation is used to get a summary of all the labels that are in use across the system. The principle use for this operation is to support search e.g. what tags can be searched for. At these levels, the meta will not contain versionId, lastUpdated etc. Systems are not obligated to implement the operation at this level (and should return a 4xx error if they don't). At the resource and historical entry level, the $meta operation returns the same meta as would be returned by accessing the resource directly. This can be used to allow a system to get access to the meta-information for the resource without accessing the resource itself, e.g. for security reasons

Add profiles, tags, and security labels to a resource

OPERATION: Add profiles, tags, and security labels to a resource

The official URL for this operation definition is: 

http://hl7.org/fhir/OperationDefinition/Resource-meta-add

This operation takes a meta, and adds the profiles, tags, and security labels found in it to the nominated resource. This operation can also be used on historical entries - to update them without creating a different historical version

URL: [base]/Resource/[id]/$meta-add

Parameters

Use Name Cardinality Type Binding Documentation
IN meta 1..1 Meta

Profiles, tags, and security labels to add to the existing resource. Note that profiles, tags, and security labels are sets, and duplicates are not created. The identity of a tag or security label is the system+code. When matching existing tags during adding, version and display are ignored. For profiles, matching is based on the full URL
OUT return 1..1 Meta

Resulting meta for the resource

This operation is special in that executing this operation does not cause a new version of the resource to be created. The meta is updated directly. This is because the content in meta does not affect the meaning of the resource, and the security labels (in particular) are used to apply access rules to existing versions of resources

Delete profiles, tags, and security labels for a resource

OPERATION: Delete profiles, tags, and security labels for a resource

The official URL for this operation definition is: 

http://hl7.org/fhir/OperationDefinition/Resource-meta-delete

This operation takes a meta, and deletes the profiles, tags, and security labels found in it from the nominated resource. This operation can also be used on historical entries

URL: [base]/Resource/[id]/$meta-delete

Parameters

Use Name Cardinality Type Binding Documentation
IN meta 1..1 Meta

Profiles, tags, and security labels to delete from the existing resource. It is not an error if these tags, profiles, and labels do not exist. The identity of a tag or security label is the system+code. When matching existing tags during deletion, version and display are ignored. For profiles, matching is based on the full URL
OUT return 1..1 Meta

Resulting meta for the resource

This operation is special in that executing this operation does not cause a new version of the resource to be created. The meta is updated directly. This is because the content in meta does not affect the meaning of the resource, and the security labels (in particular) are used to apply access rules to existing versions of resources

Validate a resource

OPERATION: Validate a resource

The official URL for this operation definition is: 

http://hl7.org/fhir/OperationDefinition/Resource-validate

The validate operation checks whether the attached content would be acceptable either generally, as a create, an update or as a delete to an existing resource. The action the server takes depends on the mode parameter:

  • [mode not provided]: The server checks the content of the resource against any schema, constraint rules, and other general terminology rules
  • create: The server checks the content, and then checks that the content would be acceptable as a create (e.g. that the content would not violate any uniqueness constraints)
  • update: The server checks the content, and then checks that it would accept it as an update against the nominated specific resource (e.g. that there are no changes to immutable fields the server does not allow to change, and checking version integrity if appropriate)
  • delete: The server ignores the content, and checks that the nominated resource is allowed to be deleted (e.g. checking referential integrity rules)

Modes update and delete can only be used when the operation is invoked at the resource instance level. The return from this operation is an OperationOutcome

URL: [base]/Resource/$validate

URL: [base]/Resource/[id]/$validate

Parameters

Use Name Cardinality Type Binding Documentation
IN resource 0..1 Resource

Must be present unless the mode is "delete"
IN mode 0..1 code http://hl7.org/fhir/ValueSet/resource-validation-mode (Required)

Default is 'no action'; (e.g. general validation)
IN profile 0..1 uri

If this is nominated, then the resource is validated against this specific profile. If a profile is nominated, and the server cannot validate against the nominated profile, it SHALL return an error
OUT return 1..1 OperationOutcome

If the operation outcome does not list any errors, and a mode was specified, then this is an indication that the operation would be expected to succeed (excepting for transactional integrity issues, see below)

This operation may be used during design and development to validate application design. It can also be used at run-time. One possible use might be that a client asks the server whether a proposed update is valid as the user is editing a dialog and displays an updated error to the user. The operation can be used as part of a light-weight two phase commit protocol but there is no expectation that the server will hold the content of the resource after this operation is used, or that the server guarantees to successfully perform an actual create, update or delete after the validation operation completes.

This operation returns a 200 OK whether or not the resource is valid. A 4xx or 5xx error means that the validation itself could not be performed, and it is unknown whether the resource is valid or not.

Data Requirements

OPERATION: Data Requirements

The official URL for this operation definition is: 

http://hl7.org/fhir/OperationDefinition/ServiceDefinition-data-requirements

The data-requirements operation aggregates and returns the parameters and data requirements for the service module and all its dependencies as a single module definition library.

URL: [base]/ServiceDefinition/[id]/$data-requirements

Parameters

Use Name Cardinality Type Binding Documentation
IN evaluateAtDateTime 0..1 dateTime

An optional date and time specifying that the evaluation should be performed as though it was the given date and time. Data requirements returned will use this as the "Now" point for the purposes of determining the data requirements.
OUT return 1..1 Library

The result of the requirements gathering is a module-definition Library that describes the aggregate parameters, data requirements, and dependencies of the service.

The effect of invoking this operation is to determine the aggregate set of data requirements and dependencies for the service module. The result is a Library resource with a type of module-definition that contains all the parameter definitions and data requirements of the service module and any libraries referenced by it. Implementations SHOULD aggregate data requirements intelligently (i.e. by collapsing overlapping data requirements).

Evaluate

OPERATION: Evaluate

The official URL for this operation definition is: 

http://hl7.org/fhir/OperationDefinition/ServiceDefinition-evaluate

The evaluate operation requests clinical decision support guidance based on a specific decision support module

URL: [base]/ServiceDefinition/[id]/$evaluate

Parameters

Use Name Cardinality Type Binding Documentation
IN requestId 0..1 id

An optional client-provided identifier to track the request.
IN evaluateAtDateTime 0..1 dateTime

An optional date and time specifying that the evaluation should be performed as though it was the given date and time. The most direct implication of this is that references to "Now" within the evaluation logic of the module should result in this value. In addition, wherever possible, the data accessed by the module should appear as though it was accessed at this time. The evaluateAtDateTime value may be any time in the past or future, enabling both retrospective and prospective scenarios. If no value is provided, the date and time of the request is assumed.
IN inputParameters 0..1 Parameters

The input parameters for a request, if any. These parameters are defined by the module that is the target of the evaluation, and typically supply patient-independent information to the module.
IN inputData 0..* Any

The input data for the request. These data are defined by the data requirements of the module and typically provide patient-dependent information.
IN patient 0..1 Reference

The patient in context, if any.
IN encounter 0..1 Reference

The encounter in context, if any.
IN initiatingOrganization 0..1 Reference

The organization initiating the request.
IN initiatingPerson 0..1 Reference

The person initiating the request.
IN userType 0..1 CodeableConcept

The type of user initiating the request, e.g. patient, healthcare provider, or specific type of healthcare provider (physician, nurse, etc.).
IN userLanguage 0..1 CodeableConcept

Preferred language of the person using the system.
IN userTaskContext 0..1 CodeableConcept

The task the system user is performing, e.g. laboratory results review, medication list review, etc. This information can be used to tailor decision support outputs, such as recommended information resources.
IN receivingOrganization 0..1 Reference

The organization that will receive the response.
IN receivingPerson 0..1 Reference

The person in the receiving organization that will receive the response.
IN recipientType 0..1 CodeableConcept

The type of individual that will consume the response content. This may be different from the requesting user type (e.g. if a clinician is getting disease management guidance for provision to a patient). E.g. patient, healthcare provider or specific type of healthcare provider (physician, nurse, etc.).
IN recipientLanguage 0..1 CodeableConcept

Preferred language of the person that will consume the content.
IN setting 0..1 CodeableConcept

The current setting of the request (inpatient, outpatient, etc).
IN settingContext 0..1 CodeableConcept

Additional detail about the setting of the request, if any.
OUT return 1..1 GuidanceResponse

The result of the request as a GuidanceResponse resource.

Build Questionnaire

OPERATION: Build Questionnaire

The official URL for this operation definition is: 

http://hl7.org/fhir/OperationDefinition/StructureDefinition-questionnaire

Generates a Questionnaire instance based on a specified StructureDefinition, creating questions for each core element or extension element found in the StructureDefinition. If the operation is not called at the instance level, one of the identifier, profile or url 'in' parameters must be provided. If more than one is specified, servers may raise an error or may resolve with the parameter of their choice. If called at the instance level, these parameters will be ignored. The response will contain a Questionnaire instance based on the specified StructureDefinition and/or an OperationOutcome resource with errors or warnings. Nested groups are used to handle complex structures and data types. If the 'supportedOnly' parameter is set to true, only those elements marked as "must support" will be included. This operation is intended to enable auto-generation of simple interfaces for arbitrary profiles. The 'questionnaire' approach to data entry has limitations that will make it less optimal than custom-defined interfaces. However, this function may be useful for simple applications or for systems that wish to support "non-core" resources with minimal development effort.

URL: [base]/StructureDefinition/$questionnaire

URL: [base]/StructureDefinition/[id]/$questionnaire

Parameters

Use Name Cardinality Type Binding Documentation
IN identifier 0..1 uri

A logical profile identifier (i.e. 'StructureDefinition.identifier''). The server must know the profile or be able to retrieve it from other known repositories.
IN profile 0..1 string

The StructureDefinition is provided directly as part of the request. Servers may choose not to accept profiles in this fashion
IN url 0..1 uri

The profile's official URL (i.e. 'StructureDefinition.url'). The server must know the profile or be able to retrieve it from other known repositories.
IN supportedOnly 0..1 boolean

If true, the questionnaire will only include those elements marked as "mustSupport='true'" in the StructureDefinition.
OUT return 1..1 Questionnaire

The questionnaire form generated based on the StructureDefinition.

Open Issue: Ideally, extensions should be populated in the generated Questionnaire that will support taking QuestionnaireResponse resources generated from the Questionnaire and turning them back into the appropriate resources.

Model Instance Transformation

OPERATION: Model Instance Transformation

The official URL for this operation definition is: 

http://hl7.org/fhir/OperationDefinition/StructureMap-transform

The transform operation takes input content, applies a structure map transform, and then returns the output.

URL: [base]/StructureMap/$transform

URL: [base]/StructureMap/[id]/$transform

Parameters

Use Name Cardinality Type Binding Documentation
IN source 0..1 uri

The structure map to apply. This is only needed if the operation is invoked at the resource level. If the $transform operation is invoked on a particular structure map, this will be ignored by the server
IN content 1..1 Resource

The logical content to transform
OUT return 1..1 Resource

The result of the transform

The input and return are specified as 'Resources'. In most usage of the $transform operation, either the input or return content is not a valid FHIR resource. In these cases, the return type is actually a Binary resource. For this operation, the Binary resources may be encoded directly, using a mime-type, as shown in the example. Note: this specification does not yet address the means by which the servers may know the correct mime types for the various content involved

Value Set Expansion

OPERATION: Value Set Expansion

The official URL for this operation definition is: 

http://hl7.org/fhir/OperationDefinition/ValueSet-expand

The definition of a value set is used to create a simple collection of codes suitable for use for data entry or validation. If the operation is not called at the instance level, one of the in parameters identifier, context or valueset must be provided. An expanded value set will be returned, or an OperationOutcome with an error message.

URL: [base]/ValueSet/$expand

URL: [base]/ValueSet/[id]/$expand

Parameters

Use Name Cardinality Type Binding Documentation
IN url 0..1 uri

A canonical url for a value set. The server must know the value set (e.g. it is defined explicitly in the server's value sets, or it is defined implicitly by some code system known to the server
IN valueSet 0..1 ValueSet

The value set is provided directly as part of the request. Servers may choose not to accept value sets in this fashion
IN context 0..1 uri

The context of the value set, so that the server can resolve this to a value set to expand. The recommended format for this URI is [Structure Definition URL]#[name or path into structure definition] e.g. http://hl7.org/fhir/StructureDefinition/observation-hspc-height-hspcheight#Observation.interpretation. Other forms may be used but are not defined. This form is only usable if the terminology server also has access to the profile registry that the server is using, but can be used to delegate the mapping from an application context to a binding at run-time
IN filter 0..1 string

A text filter that is applied to restrict the codes that are returned (this is useful in a UI context). The interpretation of this is delegated to the server in order to allow to determine the most optimal search approach for the context
IN profile 0..1 uri

A reference to an external definition that provides additional control information about how the expansion is performed. At this time, there is no agreed format or functionality for the target of this URI. The VSAC Documentation provides one example of the use of this parameter. Implementers using this element will need to agree on an appropriate mechanism for use within their interoperability community. Known uses for profile include: * whether to return the value set content logical definition with the expansion * whether to include inactive concepts
IN date 0..1 dateTime

The date for which the expansion should be generated. if a date is provided, it means that the server should use the value set / code system definitions as they were on the given date, or return an error if this is not possible. Normally, the date is the current conditions (which is the default value) but under some circumstances, systems need to generate an expansion as it would have been in the past. A typical example of this would be where code selection is constrained to the set of codes that were available when the patient was treated, not when the record is being edited. Note that which date is appropriate is a matter for implementation policy.
IN offset 0..1 integer

Paging support - where to start if a subset is desired (default = 0). Offset is number of records (not number of pages)
IN count 0..1 integer

Paging support - how many codes should be provided in a partial page view. Paging only applies to flat expansions - servers ignore paging if the expansion is not flat. If count = 0, the client is asking how large the expansion is. Servers SHOULD honor this request for hierarchical expansions as well, and simply return the overall count
IN includeDesignations 0..1 boolean

Controls whether concept designations are to be included or excluded in value set expansions. Overrides the value in the expansion profile if there is one
IN includeDefinition 0..1 boolean

Controls whether the value set definition is included or excluded in value set expansions. Overrides the value in the expansion profile if there is one
IN activeOnly 0..1 boolean

Controls whether inactive concepts are included or excluded in value set expansions. Overrides the value in the expansion profile if there is one. Note that if the value set explicitly specifies that inactive codes are included, this parameter can still remove them from a specific expansion, but this parameter cannot include them if the value set excludes them
IN excludeNested 0..1 boolean

Controls whether or not the value set expansion nests codes or not (i.e. ValueSet.expansion.contains.contains). Overrides the value in the expansion profile if there is one
IN excludeNotForUI 0..1 boolean

Controls whether or not the value set expansion includes codes which cannot be displayed in user interfaces. Overrides the value in the expansion profile if there is one
IN excludePostCoordinated 0..1 boolean

Controls whether or not the value set expansion includes post coordinated codes. Overrides the value in the expansion profile if there is one
IN displayLanguage 0..1 code

Specifies the language to be used for description in the expansions i.e. the language to be used for ValueSet.expansion.contains.display. Overrides the value in the expansion profile if there is one
IN limitedExpansion 0..1 boolean

If the value set being expanded is incomplete (because it is too big to expand), return a limited expansion (a subset) with an indicator that expansion is incomplete. Overrides the value in the expansion profile if there is one
OUT return 1..1 ValueSet

The result of the expansion

The value set expansion returned by this query should be treated as a transient result that will change over time (whether it does or not depends on how the value set is specified), so applications should repeat the operation each time the value set is used.

If the expansion is too large (at the discretion of the server), the server will return an error (OperationOutcome with code too-costly). Clients can work through large flat expansions in a set of pages (partial views of the full expansion) instead of just getting the full expansion in a single exchange by using offset and count parameters. Servers are not obliged to support paging, but if they do, SHALL support both the offset and count parameters. Hierarchical expansions are not subject to paging and servers simply return the entire expansion.

Different servers may return different results from expanding a value set for the following reasons:

  • The underlying code systems are different (e.g. different versions, possibly with different defined behavior)
  • The server optimizes filter includes differently, such as sorting by code frequency
  • Servers introduce arbitrary groups to assist a user to navigate the lists based either on extensions in the definition, or additional knowledge available to the server

When a server cannot correctly expand a value set because it does not fully understand the code systems (e.g. it has the wrong version, or incomplete definitions) then it SHALL return an error. If the value set itself is unbounded due to the inclusion of post-coordinated value sets (e.g. SNOMED CT, UCUM), then the extension http://hl7.org/fhir/StructureDefinition/valueset-unclosed can be used to indicate that the expansion is incomplete

Value Set based Validation

OPERATION: Value Set based Validation

The official URL for this operation definition is: 

http://hl7.org/fhir/OperationDefinition/ValueSet-validate-code

Validate that a coded value is in the set of codes allowed by a value set. If the operation is not called at the instance level, one of the in parameters "identifier" or "valueset" must be provided. One (and only one) of the in parameters (code, coding, codeableConcept) must be provided. The operation returns a result (true / false), an error message, and the recommended display for the code

URL: [base]/ValueSet/$validate-code

URL: [base]/ValueSet/[id]/$validate-code

Parameters

Use Name Cardinality Type Binding Documentation
IN url 0..1 uri

Value set Canonical URL. The server must know the value set (e.g. it is defined explicitly in the server's value sets, or it is defined implicitly by some code system known to the server
IN context 0..1 uri

The context of the value set, so that the server can resolve this to a value set to validate against. The recommended format for this URI is [Structure Definition URL]#[name or path into structure definition] e.g. http://hl7.org/fhir/StructureDefinition/observation-hspc-height-hspcheight#Observation.interpretation. Other forms may be used but are not defined. This form is only usable if the terminology server also has access to the profile registry that the server is using, but can be used to delegate the mapping from an application context to a binding at run-time
IN valueSet 0..1 ValueSet

The value set is provided directly as part of the request. Servers may choose not to accept value sets in this fashion. This parameter is used when the client wants the server to expand a value set that is not stored on the server
IN code 0..1 code

The code that is to be validated. If a code is provided, a system must be provided
IN system 0..1 uri

The system for the code that is to be validated
IN version 0..1 string

The version of the system, if one was provided in the source data
IN display 0..1 string

The display associated with the code, if provided. If a display is provided a code must be provided. If no display is provided, the server cannot validate the display value, but may choose to return a recommended display name in an extension in the outcome. Whether displays are case sensitive is code system dependent
IN coding 0..1 Coding

A coding to validate
IN codeableConcept 0..1 CodeableConcept

A full codeableConcept to validate. The server returns true if one of the coding values is in the value set, and may also validate that the codings are not in conflict with each other if more than one is present
IN date 0..1 dateTime

The date for which the validation should be checked. Normally, this is the current conditions (which is the default values) but under some circumstances, systems need to validate that a correct code was used at some point in the past. A typical example of this would be where code selection is constrained to the set of codes that were available when the patient was treated, not when the record is being edited. Note that which date is appropriate is a matter for implementation policy.
IN abstract 0..1 boolean

if true, then an abstract code is allowed to be used in the context of the code that is being validated. Typically, abstract codes are allowed to be used in value set specifications (e.g. any code that is subsumed by an abstract code). If false (which is the default value), then only concrete codes as defined by the value set are allowed
IN displayLanguage 0..1 code

Specifies the language to be used for description when validating the display property
OUT result 1..1 boolean

True if the concept details supplied are valid
OUT message 0..1 string

Error details, if result = false. If this is provided when result = true, the message carries hints and warnings
OUT display 0..1 string

A valid display for the concept if the system wishes to display this to a user
Name Flags Card. Type Description & Constraints doco
. . Resource n/a Base Resource
. . . id Σ 0..1 id Logical id of this artifact
. . . meta Σ 0..1 Meta Metadata about the resource
. . . implicitRules ?! Σ 0..1 uri A set of rules under which this content was created
. . . language 0..1 code Language of the resource content
Common Languages (Extensible but limited to All Languages)

doco Documentation for this format
Name Flags Card. Type Description & Constraints doco
. . Account DomainResource Tracks balance, charges, for patient or cost center
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
. . . identifier Σ 0..* Identifier Account number
. . . status ?! Σ 0..1 code active | inactive | entered-in-error
AccountStatus (Required)
. . . type Σ 0..1 CodeableConcept E.g. patient, expense, depreciation
Account Types (Example)
. . . name Σ 0..1 string Human-readable label
. . . subject Σ 0..1 Reference(Patient | Device | Practitioner | Location | HealthcareService | Organization) What is account tied to?
. . . period Σ 0..1 Period Transaction window
. . . active Σ 0..1 Period Time window that transactions may be posted to this account
. . . balance 0..1 Money How much is in account?
. . . coverage Σ 0..* BackboneElement The party(s) that are responsible for covering the payment of this account, and what order should they be applied to the account
. . . . coverage Σ 1..1 Reference(Coverage) The party(s) that are responsible for covering the payment of this account
. . . . priority Σ 0..1 positiveInt The priority of the coverage in the context of this account
. . . owner Σ 0..1 Reference(Organization) Who is responsible?
. . . description Σ 0..1 string Explanation of purpose/use
. . . guarantor 0..* BackboneElement Responsible for the account
. . . . party 1..1 Reference(Patient | RelatedPerson | Organization) Responsible entity
. . . . onHold 0..1 boolean Credit or other hold applied
. . . . period 0..1 Period Guarrantee account during

doco Documentation for this format
Name Flags Card. Type Description & Constraints doco
. . ActivityDefinition DomainResource The definition of a specific activity to be taken, independent of any particular patient or context
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
. . . url Σ 0..1 uri Logical URI to reference this activity definition (globally unique)
. . . identifier Σ 0..* Identifier Additional identifier for the activity definition
. . . version Σ 0..1 string Business version of the activity definition
. . . name Σ 0..1 string Name for this activity definition (computer friendly)
. . . title Σ 0..1 string Name for this activity definition (human friendly)
. . . status ?! Σ 1..1 code draft | active | retired | unknown
PublicationStatus (Required)
. . . experimental ?! Σ 0..1 boolean For testing purposes, not real usage
. . . date Σ 0..1 dateTime Date this was last changed
. . . publisher Σ 0..1 string Name of the publisher (organization or individual)
. . . description Σ 0..1 markdown Natural language description of the activity definition
. . . purpose 0..1 markdown Why this activity definition is defined
. . . usage 0..1 string Describes the clinical usage of the asset
. . . approvalDate 0..1 date When the activity definition was approved by publisher
. . . lastReviewDate 0..1 date When the activity definition was last reviewed
. . . effectivePeriod Σ 0..1 Period When the activity definition is expected to be used
. . . useContext Σ 0..* UsageContext Context the content is intended to support
. . . jurisdiction Σ 0..* CodeableConcept Intended jurisdiction for activity definition (if applicable)
Jurisdiction ValueSet (Extensible)
. . . topic 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc
DefinitionTopic (Example)
. . . contributor 0..* Contributor A content contributor
. . . contact Σ 0..* ContactDetail Contact details for the publisher
. . . copyright 0..1 markdown Use and/or publishing restrictions
. . . relatedArtifact 0..* RelatedArtifact Additional documentation, citations, etc
. . . library 0..* Reference(Library) Logic used by the asset
. . . kind 0..1 code Kind of resource
ResourceType (Required)
. . . code 0..1 CodeableConcept Detail type of activity
Procedure Codes (SNOMED CT) (Example)
. . . timing[x] 0..1 When activity is to occur
. . . . timingTiming Timing
. . . . timingDateTime dateTime
. . . . timingPeriod Period
. . . . timingRange Range
. . . location 0..1 Reference(Location) Where it should happen
. . . participant 0..* BackboneElement Who should participate in the action
. . . . type 1..1 code patient | practitioner | related-person
ActionParticipantType (Required)
. . . . role 0..1 CodeableConcept E.g. Nurse, Surgeon, Parent, etc
ActionParticipantRole (Example)
. . . product[x] 0..1 What's administered/supplied
SNOMED CT Medication Codes (Example)
. . . . productReference Reference(Medication | Substance)
. . . . productCodeableConcept CodeableConcept
. . . quantity 0..1 SimpleQuantity How much is administered/consumed/supplied
. . . dosage 0..* Dosage Detailed dosage instructions
. . . bodySite 0..* CodeableConcept What part of body to perform on
SNOMED CT Body Structures (Example)
. . . transform 0..1 Reference(StructureMap) Transform to apply the template
. . . dynamicValue 0..* BackboneElement Dynamic aspects of the definition
. . . . description 0..1 string Natural language description of the dynamic value
. . . . path 0..1 string The path to the element to be set dynamically
. . . . language 0..1 string Language of the expression
. . . . expression 0..1 string An expression that provides the dynamic value for the customization

doco Documentation for this format
Name Flags Card. Type Description & Constraints doco
. . AdverseEvent Σ DomainResource Medical care, research study or other healthcare event causing physical injury
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
. . . identifier Σ 0..1 Identifier Business identifier for the event
. . . category Σ 0..1 code AE | PAE An adverse event is an event that caused harm to a patient, an adverse reaction is a something that is a subject-specific event that is a result of an exposure to a medication, food, device or environmental substance, a potential adverse event is something that occurred and that could have caused harm to a patient but did not
AdverseEventCategory (Required)
. . . type Σ 0..1 CodeableConcept actual | potential
SNOMED CT Clinical Findings (Example)
. . . subject Σ 0..1 Reference(Patient | ResearchSubject | Medication | Device) Subject or group impacted by event
. . . date Σ 0..1 dateTime When the event occurred
. . . reaction Σ 0..* Reference(Condition) Adverse Reaction Events linked to exposure to substance
. . . location Σ 0..1 Reference(Location) Location where adverse event occurred
. . . seriousness Σ 0..1 CodeableConcept Mild | Moderate | Severe
AdverseEventSeriousness (Example)
. . . outcome Σ 0..1 CodeableConcept resolved | recovering | ongoing | resolvedWithSequelae | fatal | unknown
AdverseEventOutcome (Required)
. . . recorder Σ 0..1 Reference(Patient | Practitioner | RelatedPerson) Who recorded the adverse event
. . . eventParticipant Σ 0..1 Reference(Practitioner | Device) Who was involved in the adverse event or the potential adverse event
. . . description Σ 0..1 string Description of the adverse event
. . . suspectEntity Σ 0..* BackboneElement The suspected agent causing the adverse event
. . . . instance Σ 1..1 Reference(Substance | Medication | MedicationAdministration | MedicationStatement | Device) Refers to the specific entity that caused the adverse event
. . . . causality Σ 0..1 code causality1 | causality2
AdverseEventCausality (Required)
. . . . causalityAssessment Σ 0..1 CodeableConcept assess1 | assess2
AdverseEventCausalityAssessment (Example)
. . . . causalityProductRelatedness Σ 0..1 string AdverseEvent.suspectEntity.causalityProductRelatedness
. . . . causalityMethod Σ 0..1 CodeableConcept method1 | method2
AdverseEventCausalityMethod (Example)
. . . . causalityAuthor Σ 0..1 Reference(Practitioner | PractitionerRole) AdverseEvent.suspectEntity.causalityAuthor
. . . . causalityResult Σ 0..1 CodeableConcept result1 | result2
AdverseEventCausalityResult (Example)
. . . subjectMedicalHistory Σ 0..* Reference(Condition | Observation | AllergyIntolerance | FamilyMemberHistory | Immunization | Procedure) AdverseEvent.subjectMedicalHistory
. . . referenceDocument Σ 0..* Reference(DocumentReference) AdverseEvent.referenceDocument
. . . study Σ 0..* Reference(ResearchStudy) AdverseEvent.study

doco Documentation for this format
Name Flags Card. Type Description & Constraints doco
. . AllergyIntolerance I DomainResource Allergy or Intolerance (generally: Risk of adverse reaction to a substance)
+ AllergyIntolerance.clinicalStatus SHALL be present if verificationStatus is not entered-in-error.
+ AllergyIntolerance.clinicalStatus SHALL NOT be present if verification Status is entered-in-error
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
. . . identifier Σ 0..* Identifier External ids for this item
. . . clinicalStatus ?! Σ I 0..1 code active | inactive | resolved
AllergyIntoleranceClinicalStatus (Required)
. . . verificationStatus ?! Σ I 1..1 code unconfirmed | confirmed | refuted | entered-in-error
AllergyIntoleranceVerificationStatus (Required)
. . . type Σ 0..1 code allergy | intolerance - Underlying mechanism (if known)
AllergyIntoleranceType (Required)
. . . category Σ 0..* code food | medication | environment | biologic
AllergyIntoleranceCategory (Required)
. . . criticality Σ 0..1 code low | high | unable-to-assess
AllergyIntoleranceCriticality (Required)
. . . code Σ 0..1 CodeableConcept Code that identifies the allergy or intolerance
AllergyIntolerance Substance/Product, Condition and Negation Codes (Example)
. . . patient Σ 1..1 Reference(Patient) Who the sensitivity is for
. . . onset[x] 0..1 When allergy or intolerance was identified
. . . . onsetDateTime dateTime
. . . . onsetAge Age
. . . . onsetPeriod Period
. . . . onsetRange Range
. . . . onsetString string
. . . assertedDate 0..1 dateTime Date record was believed accurate
. . . recorder 0..1 Reference(Practitioner | Patient) Who recorded the sensitivity
. . . asserter Σ 0..1 Reference(Patient | RelatedPerson | Practitioner) Source of the information about the allergy
. . . lastOccurrence 0..1 dateTime Date(/time) of last known occurrence of a reaction
. . . note 0..* Annotation Additional text not captured in other fields
. . . reaction 0..* BackboneElement Adverse Reaction Events linked to exposure to substance
. . . . substance 0..1 CodeableConcept Specific substance or pharmaceutical product considered to be responsible for event
Substance Code (Example)
. . . . manifestation 1..* CodeableConcept Clinical symptoms/signs associated with the Event
SNOMED CT Clinical Findings (Example)
. . . . description 0..1 string Description of the event as a whole
. . . . onset 0..1 dateTime Date(/time) when manifestations showed
. . . . severity 0..1 code mild | moderate | severe (of event as a whole)
AllergyIntoleranceSeverity (Required)
. . . . exposureRoute 0..1 CodeableConcept How the subject was exposed to the substance
SNOMED CT Route Codes (Example)
. . . . note 0..* Annotation Text about event not captured in other fields

doco Documentation for this format
Name Flags Card. Type Description & Constraints doco
. . Appointment I DomainResource A booking of a healthcare event among patient(s), practitioner(s), related person(s) and/or device(s) for a specific date/time. This may result in one or more Encounter(s)
+ Only proposed or cancelled appointments can be missing start/end dates
+ Either start and end are specified, or neither
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
. . . identifier Σ 0..* Identifier External Ids for this item
. . . status ?! Σ 1..1 code proposed | pending | booked | arrived | fulfilled | cancelled | noshow | entered-in-error
AppointmentStatus (Required)
. . . serviceCategory Σ 0..1 CodeableConcept A broad categorisation of the service that is to be performed during this appointment
ServiceCategory (Example)
. . . serviceType Σ 0..* CodeableConcept The specific service that is to be performed during this appointment
ServiceType (Example)
. . . specialty Σ 0..* CodeableConcept The specialty of a practitioner that would be required to perform the service requested in this appointment
Practice Setting Code Value Set (Preferred)
. . . appointmentType Σ 0..1 CodeableConcept The style of appointment or patient that has been booked in the slot (not service type)
v2 Appointment reason codes (Preferred)
. . . reason Σ 0..* CodeableConcept Reason this appointment is scheduled
Encounter Reason Codes (Preferred)
. . . indication 0..* Reference(Condition | Procedure) Reason the appointment is to takes place (resource)
. . . priority 0..1 unsignedInt Used to make informed decisions if needing to re-prioritize
. . . description 0..1 string Shown on a subject line in a meeting request, or appointment list
. . . supportingInformation 0..* Reference(Any) Additional information to support the appointment
. . . start Σ 0..1 instant When appointment is to take place
. . . end Σ 0..1 instant When appointment is to conclude
. . . minutesDuration 0..1 positiveInt Can be less than start/end (e.g. estimate)
. . . slot 0..* Reference(Slot) The slots that this appointment is filling
. . . created 0..1 dateTime The date that this appointment was initially created
. . . comment 0..1 string Additional comments
. . . incomingReferral 0..* Reference(ReferralRequest) The ReferralRequest provided as information to allocate to the Encounter
. . . participant I 1..* BackboneElement Participants involved in appointment
+ Either the type or actor on the participant SHALL be specified
. . . . type Σ 0..* CodeableConcept Role of participant in the appointment
ParticipantType (Extensible)
. . . . actor Σ 0..1 Reference(Patient | Practitioner | RelatedPerson | Device | HealthcareService | Location) Person, Location/HealthcareService or Device
. . . . required Σ 0..1 code required | optional | information-only
ParticipantRequired (Required)
. . . . status 1..1 code accepted | declined | tentative | needs-action
ParticipationStatus (Required)
. . . requestedPeriod 0..* Period Potential date/time interval(s) requested to allocate the appointment within

doco Documentation for this format
Name Flags Card. Type Description & Constraints doco
. . AppointmentResponse I DomainResource A reply to an appointment request for a patient and/or practitioner(s), such as a confirmation or rejection
+ Either the participantType or actor must be specified
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
. . . identifier Σ 0..* Identifier External Ids for this item
. . . appointment Σ 1..1 Reference(Appointment) Appointment this response relates to
. . . start 0..1 instant Time from appointment, or requested new start time
. . . end 0..1 instant Time from appointment, or requested new end time
. . . participantType Σ 0..* CodeableConcept Role of participant in the appointment
ParticipantType (Extensible)
. . . actor Σ 0..1 Reference(Patient | Practitioner | RelatedPerson | Device | HealthcareService | Location) Person, Location/HealthcareService or Device
. . . participantStatus ?! Σ 1..1 code accepted | declined | tentative | in-process | completed | needs-action | entered-in-error
ParticipationStatus (Required)
. . . comment 0..1 string Additional comments

doco Documentation for this format
Name Flags Card. Type Description & Constraints doco
. . AuditEvent DomainResource Event record kept for security purposes
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
. . . type Σ 1..1 Coding Type/identifier of event
Audit Event ID (Extensible)
. . . subtype Σ 0..* Coding More specific type/id for the event
Audit Event Sub-Type (Extensible)
. . . action Σ 0..1 code Type of action performed during the event
AuditEventAction (Required)
. . . recorded Σ 1..1 instant Time when the event occurred on source
. . . outcome Σ 0..1 code Whether the event succeeded or failed
AuditEventOutcome (Required)
. . . outcomeDesc Σ 0..1 string Description of the event outcome
. . . purposeOfEvent Σ 0..* CodeableConcept The purposeOfUse of the event
PurposeOfUse (Extensible)
. . . agent 1..* BackboneElement Actor involved in the event
. . . . role 0..* CodeableConcept Agent role in the event
SecurityRoleType (Extensible)
. . . . reference Σ 0..1 Reference(Practitioner | Organization | Device | Patient | RelatedPerson) Direct reference to resource
. . . . userId Σ 0..1 Identifier Unique identifier for the user
. . . . altId 0..1 string Alternative User id e.g. authentication
. . . . name 0..1 string Human-meaningful name for the agent
. . . . requestor 1..1 boolean Whether user is initiator
. . . . location 0..1 Reference(Location) Where
. . . . policy 0..* uri Policy that authorized event
. . . . media 0..1 Coding Type of media
Media Type Code (Extensible)
. . . . network 0..1 BackboneElement Logical network location for application activity
. . . . . address 0..1 string Identifier for the network access point of the user device
. . . . . type 0..1 code The type of network access point
AuditEventAgentNetworkType (Required)
. . . . purposeOfUse 0..* CodeableConcept Reason given for this user
PurposeOfUse (Extensible)
. . . source 1..1 BackboneElement Audit Event Reporter
. . . . site 0..1 string Logical source location within the enterprise
. . . . identifier Σ 1..1 Identifier The identity of source detecting the event
. . . . type 0..* Coding The type of source where event originated
Audit Event Source Type (Extensible)
. . . entity I 0..* BackboneElement Data or objects used
+ Either a name or a query (NOT both)
. . . . identifier Σ 0..1 Identifier Specific instance of object
. . . . reference Σ 0..1 Reference(Any) Specific instance of resource
. . . . type 0..1 Coding Type of entity involved
AuditEventEntityType (Extensible)
. . . . role 0..1 Coding What role the entity played
AuditEventEntityRole (Extensible)
. . . . lifecycle 0..1 Coding Life-cycle stage for the entity
ObjectLifecycleEvents (Extensible)
. . . . securityLabel 0..* Coding Security labels on the entity
All Security Labels (Extensible)
. . . . name Σ I 0..1 string Descriptor for entity
. . . . description 0..1 string Descriptive text
. . . . query Σ I 0..1 base64Binary Query parameters
. . . . detail 0..* BackboneElement Additional Information about the entity
. . . . . type 1..1 string Name of the property
. . . . . value 1..1 base64Binary Property value

doco Documentation for this format
Name Flags Card. Type Description & Constraints doco
. . Basic Σ DomainResource Resource for non-supported content
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
. . . identifier Σ 0..* Identifier Business identifier
. . . code ?! Σ 1..1 CodeableConcept Kind of Resource
Basic Resource Types (Example)
. . . subject Σ 0..1 Reference(Any) Identifies the focus of this resource
. . . created Σ 0..1 date When created
. . . author Σ 0..1 Reference(Practitioner | Patient | RelatedPerson) Who created

doco Documentation for this format
Name Flags Card. Type Description & Constraints doco
. . Binary Resource Pure binary content defined by a format other than FHIR
Elements defined in Ancestors: id, meta, implicitRules, language
. . . contentType Σ 1..1 code MimeType of the binary content
MimeType (Required)
. . . securityContext Σ 0..1 Reference(Any) Access Control Management
. . . content 1..1 base64Binary The actual content

doco Documentation for this format
Name Flags Card. Type Description & Constraints doco
. . BodySite DomainResource Specific and identified anatomical location
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
. . . identifier Σ 0..* Identifier Bodysite identifier
. . . active ?! Σ 0..1 boolean Whether this body site record is in active use
. . . code Σ 0..1 CodeableConcept Named anatomical location
SNOMED CT Body Structures (Example)
. . . qualifier 0..* CodeableConcept Modification to location code
Bodysite Location Qualifier (Example)
. . . description Σ 0..1 string Anatomical location description
. . . image 0..* Attachment Attached images
. . . patient Σ 1..1 Reference(Patient) Who this is about

doco Documentation for this format
Name Flags Card. Type Description & Constraints doco
. . Bundle Σ I Resource Contains a collection of resources
+ FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId
+ A document must have an identifier with a system and a value
+ entry.request only for some types of bundles
+ entry.response only for some types of bundles
+ total only when a search or history
+ entry.search only when a search
Elements defined in Ancestors: id, meta, implicitRules, language
. . . identifier Σ 0..1 Identifier Persistent identifier for the bundle
. . . type Σ 1..1 code document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection
BundleType (Required)
. . . total Σ I 0..1 unsignedInt If search, the total number of matches
. . . link Σ 0..* BackboneElement Links related to this Bundle
. . . . relation Σ 1..1 string See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1
. . . . url Σ 1..1 uri Reference details for the link
. . . entry Σ I 0..* BackboneElement Entry in the bundle - will have a resource, or information
+ fullUrl cannot be a version specific reference
+ must be a resource unless there's a request or response
. . . . link Σ 0..* see link Links related to this entry
. . . . fullUrl Σ 0..1 uri Absolute URL for resource (server address, or UUID/OID)
. . . . resource Σ 0..1 Resource A resource in the bundle
. . . . search Σ I 0..1 BackboneElement Search related information
. . . . . mode Σ 0..1 code match | include | outcome - why this is in the result set
SearchEntryMode (Required)
. . . . . score Σ 0..1 decimal Search ranking (between 0 and 1)
. . . . request Σ I 0..1 BackboneElement Transaction Related Information
. . . . . method Σ 1..1 code GET | POST | PUT | DELETE
HTTPVerb (Required)
. . . . . url Σ 1..1 uri URL for HTTP equivalent of this entry
. . . . . ifNoneMatch Σ 0..1 string For managing cache currency
. . . . . ifModifiedSince Σ 0..1 instant For managing update contention
. . . . . ifMatch Σ 0..1 string For managing update contention
. . . . . ifNoneExist Σ 0..1 string For conditional creates
. . . . response Σ I 0..1 BackboneElement Transaction Related Information
. . . . . status Σ 1..1 string Status response code (text optional)
. . . . . location Σ 0..1 uri The location, if the operation returns a location
. . . . . etag Σ 0..1 string The etag for the resource (if relevant)
. . . . . lastModified Σ 0..1 instant Server's date time modified
. . . . . outcome Σ 0..1 Resource OperationOutcome with hints and warnings (for batch/transaction)
. . . signature Σ 0..1 Signature Digital Signature

doco Documentation for this format
Name Flags Card. Type Description & Constraints doco
. . CapabilityStatement I DomainResource A statement of system capabilities
+ There can only be one REST declaration per mode.
+ The set of documents must be unique by the combination of profile and mode.
+ Capability Statements of kind 'instance' do not have implementation elements.
+ Messaging end-point is required (and is only permitted) when a statement is for an implementation.
+ Capability Statements of kind 'requirements' do not have software or implementation elements.
+ A Capability Statement SHALL have at least one of description, software, or implementation element.
+ A Capability Statement SHALL have at least one of REST, messaging or document element.
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
. . . url Σ 0..1 uri Logical URI to reference this capability statement (globally unique)
. . . version Σ 0..1 string Business version of the capability statement
. . . name Σ 0..1 string Name for this capability statement (computer friendly)
. . . title Σ 0..1 string Name for this capability statement (human friendly)
. . . status ?! Σ 1..1 code draft | active | retired | unknown
PublicationStatus (Required)
. . . experimental ?! Σ 0..1 boolean For testing purposes, not real usage
. . . date Σ 1..1 dateTime Date this was last changed
. . . publisher Σ 0..1 string Name of the publisher (organization or individual)
. . . contact Σ 0..* ContactDetail Contact details for the publisher
. . . description I 0..1 markdown Natural language description of the capability statement
. . . useContext Σ 0..* UsageContext Context the content is intended to support
. . . jurisdiction Σ 0..* CodeableConcept Intended jurisdiction for capability statement (if applicable)
Jurisdiction ValueSet (Extensible)
. . . purpose 0..1 markdown Why this capability statement is defined
. . . copyright 0..1 markdown Use and/or publishing restrictions
. . . kind Σ 1..1 code instance | capability | requirements
CapabilityStatementKind (Required)
. . . instantiates Σ 0..* uri Canonical URL of another capability statement this implements
. . . software Σ I 0..1 BackboneElement Software that is covered by this capability statement
. . . . name Σ 1..1 string A name the software is known by
. . . . version Σ 0..1 string Version covered by this statement
. . . . releaseDate Σ 0..1 dateTime Date this version released
. . . implementation Σ I 0..1 BackboneElement If this describes a specific instance
. . . . description Σ 1..1 string Describes this specific instance
. . . . url Σ 0..1 uri Base URL for the installation
. . . fhirVersion Σ 1..1 id FHIR Version the system uses
. . . acceptUnknown Σ 1..1 code no | extensions | elements | both
UnknownContentCode (Required)
. . . format Σ 1..* code formats supported (xml | json | ttl | mime type)
MimeType (Required)
. . . patchFormat Σ 0..* code Patch formats supported
MimeType (Required)
. . . implementationGuide Σ 0..* uri Implementation guides supported
. . . profile Σ 0..* Reference(StructureDefinition) Profiles for use cases supported
. . . rest Σ I 0..* BackboneElement If the endpoint is a RESTful one
+ A given resource can only be described once per RESTful mode.
. . . . mode Σ 1..1 code client | server
RestfulCapabilityMode (Required)
. . . . documentation 0..1 string General description of implementation
. . . . security Σ 0..1 BackboneElement Information about security of implementation
. . . . . cors Σ 0..1 boolean Adds CORS Headers (http://enable-cors.org/)
. . . . . service Σ 0..* CodeableConcept OAuth | SMART-on-FHIR | NTLM | Basic | Kerberos | Certificates
RestfulSecurityService (Extensible)
. . . . . description 0..1 string General description of how security works
. . . . . certificate 0..* BackboneElement Certificates associated with security profiles
. . . . . . type 0..1 code Mime type for certificates
MimeType (Required)
. . . . . . blob 0..1 base64Binary Actual certificate
. . . . resource Σ I 0..* BackboneElement Resource served on the REST interface
+ Search parameter names must be unique in the context of a resource.
. . . . . type Σ 1..1 code A resource type that is supported
ResourceType (Required)
. . . . . profile Σ 0..1 Reference(StructureDefinition) Base System profile for all uses of resource
. . . . . documentation 0..1 markdown Additional information about the use of the resource type
. . . . . interaction 1..* BackboneElement What operations are supported?
. . . . . . code 1..1 code read | vread | update | patch | delete | history-instance | history-type | create | search-type
TypeRestfulInteraction (Required)
. . . . . . documentation 0..1 string Anything special about operation behavior
. . . . . versioning 0..1 code no-version | versioned | versioned-update
ResourceVersionPolicy (Required)
. . . . . readHistory 0..1 boolean Whether vRead can return past versions
. . . . . updateCreate 0..1 boolean If update can commit to a new identity
. . . . . conditionalCreate 0..1 boolean If allows/uses conditional create
. . . . . conditionalRead 0..1 code not-supported | modified-since | not-match | full-support
ConditionalReadStatus (Required)
. . . . . conditionalUpdate 0..1 boolean If allows/uses conditional update
. . . . . conditionalDelete 0..1 code not-supported | single | multiple - how conditional delete is supported
ConditionalDeleteStatus (Required)
. . . . . referencePolicy 0..* code literal | logical | resolves | enforced | local
ReferenceHandlingPolicy (Required)
. . . . . searchInclude 0..* string _include values supported by the server
. . . . . searchRevInclude 0..* string _revinclude values supported by the server
. . . . . searchParam 0..* BackboneElement Search parameters supported by implementation
. . . . . . name 1..1 string Name of search parameter
. . . . . . definition 0..1 uri Source of definition for parameter
. . . . . . type 1..1 code number | date | string | token | reference | composite | quantity | uri
SearchParamType (Required)
. . . . . . documentation 0..1 string Server-specific usage
. . . . interaction 0..* BackboneElement What operations are supported?
. . . . . code 1..1 code transaction | batch | search-system | history-system
SystemRestfulInteraction (Required)
. . . . . documentation 0..1 string Anything special about operation behavior
. . . . searchParam 0..* see searchParam Search parameters for searching all resources
. . . . operation Σ 0..* BackboneElement Definition of an operation or a custom query
. . . . . name 1..1 string Name by which the operation/query is invoked
. . . . . definition Σ 1..1 Reference(OperationDefinition) The defined operation/query
. . . . compartment 0..* uri Compartments served/used by system
. . . messaging Σ I 0..* BackboneElement If messaging is supported
+ A Capability Statement messaging element SHALL have either supportedMessage or event element, but not both.
. . . . endpoint 0..* BackboneElement Where messages should be sent
. . . . . protocol 1..1 Coding http | ftp | mllp +
MessageTransport (Extensible)
. . . . . address 1..1 uri Network address or identifier of the end-point
. . . . reliableCache 0..1 unsignedInt Reliable Message Cache Length (min)
. . . . documentation 0..1 string Messaging interface behavior details
. . . . supportedMessage Σ 0..* BackboneElement Messages supported by this system
. . . . . mode Σ 1..1 code sender | receiver
EventCapabilityMode (Required)
. . . . . definition Σ 1..1 Reference(MessageDefinition) Message supported by this system
. . . . event Σ 0..* BackboneElement Declare support for this event
. . . . . code Σ 1..1 Coding Event type
MessageEvent (Example)
. . . . . category 0..1 code Consequence | Currency | Notification
MessageSignificanceCategory (Required)
. . . . . mode 1..1 code sender | receiver
EventCapabilityMode (Required)
. . . . . focus 1..1 code Resource that's focus of message
ResourceType (Required)
. . . . . request Σ 1..1 Reference(StructureDefinition) Profile that describes the request
. . . . . response Σ 1..1 Reference(StructureDefinition) Profile that describes the response
. . . . . documentation 0..1 string Endpoint-specific event documentation
. . . document Σ I 0..* BackboneElement Document definition
. . . . mode 1..1 code producer | consumer
DocumentMode (Required)
. . . . documentation 0..1 string Description of document support
. . . . profile Σ 1..1 Reference(StructureDefinition) Constraint on a resource used in the document

doco Documentation for this format
Name Flags Card. Type Description & Constraints doco
. . CarePlan DomainResource Healthcare plan for patient or group
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
. . . identifier Σ 0..* Identifier External Ids for this plan
. . . definition Σ 0..* Reference(PlanDefinition | Questionnaire) Protocol or definition
. . . basedOn Σ 0..* Reference(CarePlan) Fulfills care plan
. . . replaces Σ 0..* Reference(CarePlan) CarePlan replaced by this CarePlan
. . . partOf Σ 0..* Reference(CarePlan) Part of referenced CarePlan
. . . status ?! Σ 1..1 code draft | active | suspended | completed | entered-in-error | cancelled | unknown
CarePlanStatus (Required)
. . . intent ?! Σ 1..1 code proposal | plan | order | option
CarePlanIntent (Required)
. . . category Σ 0..* CodeableConcept Type of plan
Care Plan Category (Example)
. . . title Σ 0..1 string Human-friendly name for the CarePlan
. . . description Σ 0..1 string Summary of nature of plan
. . . subject Σ 1..1 Reference(Patient | Group) Who care plan is for
. . . context Σ 0..1 Reference(Encounter | EpisodeOfCare) Created in context of
. . . period Σ 0..1 Period Time period plan covers
. . . author Σ 0..* Reference(Patient | Practitioner | RelatedPerson | Organization | CareTeam) Who is responsible for contents of the plan
. . . careTeam 0..* Reference(CareTeam) Who's involved in plan?
. . . addresses Σ 0..* Reference(Condition) Health issues this plan addresses
. . . supportingInfo 0..* Reference(Any) Information considered as part of plan
. . . goal 0..* Reference(Goal) Desired outcome of plan
. . . activity I 0..* BackboneElement Action to occur as part of plan
+ Provide a reference or detail, not both
. . . . outcomeCodeableConcept 0..* CodeableConcept Results of the activity
Care Plan Activity Outcome (Example)
. . . . outcomeReference 0..* Reference(Any) Appointment, Encounter, Procedure, etc.
. . . . progress 0..* Annotation Comments about the activity status/progress
. . . . reference I 0..1 Reference(Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ProcedureRequest | ReferralRequest | VisionPrescription | RequestGroup) Activity details defined in specific resource
. . . . detail I 0..1 BackboneElement In-line definition of activity
. . . . . category 0..1 CodeableConcept diet | drug | encounter | observation | procedure | supply | other
CarePlanActivityCategory (Example)
. . . . . definition 0..1 Reference(PlanDefinition | ActivityDefinition | Questionnaire) Protocol or definition
. . . . . code 0..1 CodeableConcept Detail type of activity
Care Plan Activity (Example)
. . . . . reasonCode 0..* CodeableConcept Why activity should be done or why activity was prohibited
Activity Reason (Example)
. . . . . reasonReference 0..* Reference(Condition) Condition triggering need for activity
. . . . . goal 0..* Reference(Goal) Goals this activity relates to
. . . . . status ?! 1..1 code not-started | scheduled | in-progress | on-hold | completed | cancelled | unknown
CarePlanActivityStatus (Required)
. . . . . statusReason 0..1 string Reason for current status
. . . . . prohibited ?! 0..1 boolean Do NOT do
. . . . . scheduled[x] 0..1 When activity is to occur
. . . . . . scheduledTiming Timing
. . . . . . scheduledPeriod Period
. . . . . . scheduledString string
. . . . . location 0..1 Reference(Location) Where it should happen
. . . . . performer 0..* Reference(Practitioner | Organization | RelatedPerson | Patient | CareTeam) Who will be responsible?
. . . . . product[x] 0..1 What is to be administered/supplied
SNOMED CT Medication Codes (Example)
. . . . . . productCodeableConcept CodeableConcept
. . . . . . productReference Reference(Medication | Substance)
. . . . . dailyAmount 0..1 SimpleQuantity How to consume/day?
. . . . . quantity 0..1 SimpleQuantity How much to administer/supply/consume
. . . . . description 0..1 string Extra info describing activity to perform
. . . note 0..* Annotation Comments about the plan

doco Documentation for this format
Name Flags Card. Type Description & Constraints doco
. . CareTeam DomainResource Planned participants in the coordination and delivery of care for a patient or group
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
. . . identifier Σ 0..* Identifier External Ids for this team
. . . status ?! Σ 0..1 code proposed | active | suspended | inactive | entered-in-error
CareTeamStatus (Required)
. . . category Σ 0..* CodeableConcept Type of team
CareTeamCategory (Example)
. . . name Σ 0..1 string Name of the team, such as crisis assessment team
. . . subject Σ 0..1 Reference(Patient | Group) Who care team is for
. . . context Σ 0..1 Reference(Encounter | EpisodeOfCare) Encounter or episode associated with CareTeam
. . . period Σ 0..1 Period Time period team covers
. . . participant I 0..* BackboneElement Members of the team
+ CareTeam.participant.onBehalfOf can only be populated when CareTeam.participant.member is a Practitioner
. . . . role Σ 0..1 CodeableConcept Type of involvement
Participant Roles (Example)
. . . . member Σ 0..1 Reference(Practitioner | RelatedPerson | Patient | Organization | CareTeam) Who is involved
. . . . onBehalfOf Σ 0..1 Reference(Organization) Organization of the practitioner
. . . . period 0..1 Period Time period of participant
. . . reasonCode 0..* CodeableConcept Why the care team exists
SNOMED CT Clinical Findings (Example)
. . . reasonReference 0..* Reference(Condition) Why the care team exists
. . . managingOrganization Σ 0..* Reference(Organization) Organization responsible for the care team
. . . note 0..* Annotation Comments made about the CareTeam

doco Documentation for this format
Name Flags Card. Type Description & Constraints doco
. . ChargeItem DomainResource Item containing charge code(s) associated with the provision of healthcare provider products
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
. . . identifier Σ 0..1 Identifier Business Identifier for item
. . . definition 0..* uri Defining information about the code of this charge item
. . . status ?! Σ 1..1 code planned | billable | not-billable | aborted | billed | entered-in-error | unknown
ChargeItemStatus (Required)
. . . partOf 0..* Reference(ChargeItem) Part of referenced ChargeItem
. . . code Σ 1..1 CodeableConcept A code that identifies the charge, like a billing code
ChargeItemCode (Example)
. . . subject Σ 1..1 Reference(Patient | Group) Individual service was done for/to
. . . context Σ 0..1 Reference(Encounter | EpisodeOfCare) Encounter / Episode associated with event
. . . occurrence[x] Σ 0..1 When the charged service was applied
. . . . occurrenceDateTime dateTime
. . . . occurrencePeriod Period
. . . . occurrenceTiming Timing
. . . participant 0..* BackboneElement Who performed charged service
. . . . role 0..1 CodeableConcept What type of performance was done
Procedure Performer Role Codes (Example)
. . . . actor 1..1 Reference(Practitioner | Organization | Patient | Device | RelatedPerson) Individual who was performing
. . . performingOrganization 0..1 Reference(Organization) Organization providing the charged sevice
. . . requestingOrganization 0..1 Reference(Organization) Organization requesting the charged service
. . . quantity Σ 0..1 Quantity Quantity of which the charge item has been serviced
. . . bodysite Σ 0..* CodeableConcept Anatomical location, if relevant
SNOMED CT Body Structures (Example)
. . . factorOverride 0..1 decimal Factor overriding the associated rules
. . . priceOverride 0..1 Money Price overriding the associated rules
. . . overrideReason 0..1 string Reason for overriding the list price/factor
. . . enterer Σ 0..1 Reference(Practitioner | Organization | Patient | Device | RelatedPerson) Individual who was entering
. . . enteredDate Σ 0..1 dateTime Date the charge item was entered
. . . reason 0..* CodeableConcept Why was the charged service rendered?
ICD-10 Codes (Example)
. . . service 0..* Reference(DiagnosticReport | ImagingStudy | Immunization | MedicationAdministration | MedicationDispense | Observation | Procedure | SupplyDelivery) Which rendered service is being charged?
. . . account Σ 0..* Reference(Account) Account to place this charge
. . . note 0..* Annotation Comments made about the ChargeItem
. . . supportingInformation 0..* Reference(Any) Further information supporting the this charge

doco Documentation for this format
Name Flags Card. Type Description & Constraints doco
. . Claim DomainResource Claim, Pre-determination or Pre-authorization
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
. . . identifier 0..* Identifier Claim number
. . . status ?! Σ 0..1 code active | cancelled | draft | entered-in-error
Financial Resource Status Codes (Required)
. . . type 0..1 CodeableConcept Type or discipline
Example Claim Type Codes (Required)
. . . subType 0..* CodeableConcept Finer grained claim type information
Example Claim SubType Codes (Example)
. . . use 0..1 code complete | proposed | exploratory | other
Use (Required)
. . . patient 0..1 Reference(Patient) The subject of the Products and Services
. . . billablePeriod 0..1 Period Period for charge submission
. . . created 0..1 dateTime Creation date
. . . enterer 0..1 Reference(Practitioner) Author
. . . insurer 0..1 Reference(Organization) Target
. . . provider 0..1 Reference(Practitioner) Responsible provider
. . . organization 0..1 Reference(Organization) Responsible organization
. . . priority 0..1 CodeableConcept Desired processing priority
Process Priority Codes (Example)
. . . fundsReserve 0..1 CodeableConcept Funds requested to be reserved
Funds Reservation Codes (Example)
. . . related 0..* BackboneElement Related Claims which may be revelant to processing this claimn
. . . . claim 0..1 Reference(Claim) Reference to the related claim
. . . . relationship 0..1 CodeableConcept How the reference claim is related
Example Related Claim Relationship Codes (Example)
. . . . reference 0..1 Identifier Related file or case reference
. . . prescription 0..1 Reference(MedicationRequest | VisionPrescription) Prescription authorizing services or products
. . . originalPrescription 0..1 Reference(MedicationRequest) Original prescription if superceded by fulfiller
. . . payee 0..1 BackboneElement Party to be paid any benefits payable
. . . . type 1..1 CodeableConcept Type of party: Subscriber, Provider, other
Claim Payee Type Codes (Example)
. . . . resourceType 0..1 Coding organization | patient | practitioner | relatedperson
ClaimPayeeResourceType (Example)
. . . . party 0..1 Reference(Practitioner | Organization | Patient | RelatedPerson) Party to receive the payable
. . . referral 0..1 Reference(ReferralRequest) Treatment Referral
. . . facility 0..1 Reference(Location) Servicing Facility
. . . careTeam 0..* BackboneElement Members of the care team
. . . . sequence 1..1 positiveInt Number to covey order of careTeam
. . . . provider 1..1 Reference(Practitioner | Organization) Provider individual or organization
. . . . responsible 0..1 boolean Billing provider
. . . . role 0..1 CodeableConcept Role on the team
Claim Care Team Role Codes (Example)
. . . . qualification 0..1 CodeableConcept Type, classification or Specialization
Example Provider Qualification Codes (Example)
. . . information 0..* BackboneElement Exceptions, special considerations, the condition, situation, prior or concurrent issues
. . . . sequence 1..1 positiveInt Information instance identifier
. . . . category 1..1 CodeableConcept General class of information
Claim Information Category Codes (Example)
. . . . code 0..1 CodeableConcept Type of information
Exception Codes (Example)
. . . . timing[x] 0..1 When it occurred
. . . . . timingDate date
. . . . . timingPeriod Period
. . . . value[x] 0..1 Additional Data or supporting information
. . . . . valueString string
. . . . . valueQuantity Quantity
. . . . . valueAttachment Attachment
. . . . . valueReference Reference(Any)
. . . . reason 0..1 CodeableConcept Reason associated with the information
Missing Tooth Reason Codes (Example)
. . . diagnosis 0..* BackboneElement List of Diagnosis
. . . . sequence 1..1 positiveInt Number to covey order of diagnosis
. . . . diagnosis[x] 1..1 Patient's diagnosis
ICD-10 Codes (Example)
. . . . . diagnosisCodeableConcept CodeableConcept
. . . . . diagnosisReference Reference(Condition)
. . . . type 0..* CodeableConcept Timing or nature of the diagnosis
Example Diagnosis Type Codes (Example)
. . . . packageCode 0..1 CodeableConcept Package billing code
Example Diagnosis Related Group Codes (Example)
. . . procedure 0..* BackboneElement Procedures performed
. . . . sequence 1..1 positiveInt Procedure sequence for reference
. . . . date 0..1 dateTime When the procedure was performed
. . . . procedure[x] 1..1 Patient's list of procedures performed
ICD-10 Procedure Codes (Example)
. . . . . procedureCodeableConcept CodeableConcept
. . . . . procedureReference Reference(Procedure)
. . . insurance 0..* BackboneElement Insurance or medical plan
. . . . sequence 1..1 positiveInt Service instance identifier
. . . . focal 1..1 boolean Is the focal Coverage
. . . . coverage 1..1 Reference(Coverage) Insurance information
. . . . businessArrangement 0..1 string Business agreement
. . . . preAuthRef 0..* string Pre-Authorization/Determination Reference
. . . . claimResponse 0..1 Reference(ClaimResponse) Adjudication results
. . . accident 0..1 BackboneElement Details about an accident
. . . . date 1..1 date When the accident occurred see information codes see information codes
. . . . type 0..1 CodeableConcept The nature of the accident
ActIncidentCode (Required)
. . . . location[x] 0..1 Accident Place
. . . . . locationAddress Address
. . . . . locationReference Reference(Location)
. . . employmentImpacted 0..1 Period Period unable to work
. . . hospitalization 0..1 Period Period in hospital
. . . item 0..* BackboneElement Goods and Services
. . . . sequence 1..1 positiveInt Service instance
. . . . careTeamLinkId 0..* positiveInt Applicable careTeam members
. . . . diagnosisLinkId 0..* positiveInt Applicable diagnoses
. . . . procedureLinkId 0..* positiveInt Applicable procedures
. . . . informationLinkId 0..* positiveInt Applicable exception and supporting information
. . . . revenue 0..1 CodeableConcept Revenue or cost center code
Example Revenue Center Codes (Example)
. . . . category 0..1 CodeableConcept Type of service or product
Benefit SubCategory Codes (Example)
. . . . service 0..1 CodeableConcept Billing Code
USCLS Codes (Example)
. . . . modifier 0..* CodeableConcept Service/Product billing modifiers
Modifier type Codes (Example)
. . . . programCode 0..* CodeableConcept Program specific reason for item inclusion
Example Program Reason Codes (Example)
. . . . serviced[x] 0..1 Date or dates of Service
. . . . . servicedDate date
. . . . . servicedPeriod Period
. . . . location[x] 0..1 Place of service
Example Service Place Codes (Example)
. . . . . locationCodeableConcept CodeableConcept
. . . . . locationAddress Address
. . . . . locationReference Reference(Location)
. . . . quantity 0..1 SimpleQuantity Count of Products or Services
. . . . unitPrice 0..1 Money Fee, charge or cost per point
. . . . factor 0..1 decimal Price scaling factor
. . . . net 0..1 Money Total item cost
. . . . udi 0..* Reference(Device) Unique Device Identifier
. . . . bodySite 0..1 CodeableConcept Service Location
Oral Site Codes (Example)
. . . . subSite 0..* CodeableConcept Service Sub-location
Surface Codes (Example)
. . . . encounter 0..* Reference(Encounter) Encounters related to this billed item
. . . . detail 0..* BackboneElement Additional items
. . . . . sequence 1..1 positiveInt Service instance
. . . . . revenue 0..1 CodeableConcept Revenue or cost center code
Example Revenue Center Codes (Example)
. . . . . category 0..1 CodeableConcept Type of service or product
Benefit SubCategory Codes (Example)
. . . . . service 0..1 CodeableConcept Billing Code
USCLS Codes (Example)
. . . . . modifier 0..* CodeableConcept Service/Product billing modifiers
Modifier type Codes (Example)
. . . . . programCode 0..* CodeableConcept Program specific reason for item inclusion
Example Program Reason Codes (Example)
. . . . . quantity 0..1 SimpleQuantity Count of Products or Services
. . . . . unitPrice 0..1 Money Fee, charge or cost per point
. . . . . factor 0..1 decimal Price scaling factor
. . . . . net 0..1 Money Total additional item cost
. . . . . udi 0..* Reference(Device) Unique Device Identifier
. . . . . subDetail 0..* BackboneElement Additional items
. . . . . . sequence 1..1 positiveInt Service instance
. . . . . . revenue 0..1 CodeableConcept Revenue or cost center code
Example Revenue Center Codes (Example)
. . . . . . category 0..1 CodeableConcept Type of service or product
Benefit SubCategory Codes (Example)
. . . . . . service 0..1 CodeableConcept Billing Code
USCLS Codes (Example)
. . . . . . modifier 0..* CodeableConcept Service/Product billing modifiers
Modifier type Codes (Example)
. . . . . . programCode 0..* CodeableConcept Program specific reason for item inclusion
Example Program Reason Codes (Example)
. . . . . . quantity 0..1 SimpleQuantity Count of Products or Services
. . . . . . unitPrice 0..1 Money Fee, charge or cost per point
. . . . . . factor 0..1 decimal Price scaling factor
. . . . . . net 0..1 Money Net additional item cost
. . . . . . udi 0..* Reference(Device) Unique Device Identifier
. . . total 0..1 Money Total claim cost

doco Documentation for this format
Name Flags Card. Type Description & Constraints doco
. . ClaimResponse DomainResource Remittance resource
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
. . . identifier 0..* Identifier Response number
. . . status ?! Σ 0..1 code active | cancelled | draft | entered-in-error
Financial Resource Status Codes (Required)
. . . patient 0..1 Reference(Patient) The subject of the Products and Services
. . . created 0..1 dateTime Creation date
. . . insurer 0..1 Reference(Organization) Insurance issuing organization
. . . requestProvider 0..1 Reference(Practitioner) Responsible practitioner
. . . requestOrganization 0..1 Reference(Organization) Responsible organization
. . . request 0..1 Reference(Claim) Id of resource triggering adjudication
. . . outcome 0..1 CodeableConcept complete | error | partial
Claim Processing Codes (Example)
. . . disposition 0..1 string Disposition Message
. . . payeeType 0..1 CodeableConcept Party to be paid any benefits payable
Claim Payee Type Codes (Example)
. . . item 0..* BackboneElement Line items
. . . . sequenceLinkId 1..1 positiveInt Service instance
. . . . noteNumber 0..* positiveInt List of note numbers which apply
. . . . adjudication 0..* BackboneElement Adjudication details
. . . . . category 1..1 CodeableConcept Adjudication category such as co-pay, eligible, benefit, etc.
Adjudication Value Codes (Example)
. . . . . reason 0..1 CodeableConcept Explanation of Adjudication outcome
Adjudication Reason Codes (Example)
. . . . . amount 0..1 Money Monetary amount
. . . . . value 0..1 decimal Non-monetary value
. . . . detail 0..* BackboneElement Detail line items
. . . . . sequenceLinkId 1..1 positiveInt Service instance
. . . . . noteNumber 0..* positiveInt List of note numbers which apply
. . . . . adjudication 0..* see adjudication Detail level adjudication details
. . . . . subDetail 0..* BackboneElement Subdetail line items
. . . . . . sequenceLinkId 1..1 positiveInt Service instance
. . . . . . noteNumber 0..* positiveInt List of note numbers which apply
. . . . . . adjudication 0..* see adjudication Subdetail level adjudication details
. . . addItem 0..* BackboneElement Insurer added line items
. . . . sequenceLinkId 0..* positiveInt Service instances
. . . . revenue 0..1 CodeableConcept Revenue or cost center code
Example Revenue Center Codes (Example)
. . . . category 0..1 CodeableConcept Type of service or product
Benefit SubCategory Codes (Example)
. . . . service 0..1 CodeableConcept Group, Service or Product
USCLS Codes (Example)
. . . . modifier 0..* CodeableConcept Service/Product billing modifiers
Modifier type Codes (Example)
. . . . fee 0..1 Money Professional fee or Product charge
. . . . noteNumber 0..* positiveInt List of note numbers which apply
. . . . adjudication 0..* see adjudication Added items adjudication
. . . . detail 0..* BackboneElement Added items details
. . . . . revenue 0..1 CodeableConcept Revenue or cost center code
Example Revenue Center Codes (Example)
. . . . . category 0..1 CodeableConcept Type of service or product
Benefit SubCategory Codes (Example)
. . . . . service 0..1 CodeableConcept Service or Product
USCLS Codes (Example)
. . . . . modifier 0..* CodeableConcept Service/Product billing modifiers
Modifier type Codes (Example)
. . . . . fee 0..1 Money Professional fee or Product charge
. . . . . noteNumber 0..* positiveInt List of note numbers which apply
. . . . . adjudication 0..* see adjudication Added items detail adjudication
. . . error 0..* BackboneElement Processing errors
. . . . sequenceLinkId 0..1 positiveInt Item sequence number
. . . . detailSequenceLinkId 0..1 positiveInt Detail sequence number
. . . . subdetailSequenceLinkId 0..1 positiveInt Subdetail sequence number
. . . . code 1..1 CodeableConcept Error code detailing processing issues
Adjudication Error Codes (Example)
. . . totalCost 0..1 Money Total Cost of service from the Claim
. . . unallocDeductable 0..1 Money Unallocated deductible
. . . totalBenefit 0..1 Money Total benefit payable for the Claim
. . . payment 0..1 BackboneElement Payment details, if paid
. . . . type 0..1 CodeableConcept Partial or Complete
Example Payment Type Codes (Example)
. . . . adjustment 0..1 Money Payment adjustment for non-Claim issues
. . . . adjustmentReason 0..1 CodeableConcept Explanation for the non-claim adjustment
Payment Adjustment Reason Codes (Example)
. . . . date 0..1 date Expected data of Payment
. . . . amount 0..1 Money Payable amount after adjustment
. . . . identifier 0..1 Identifier Identifier of the payment instrument
. . . reserved 0..1 Coding Funds reserved status
Funds Reservation Codes (Example)
. . . form 0..1 CodeableConcept Printed Form Identifier
Form Codes (Example)
. . . processNote 0..* BackboneElement Processing notes
. . . . number 0..1 positiveInt Sequence Number for this note
. . . . type 0..1 CodeableConcept display | print | printoper
NoteType (Required)
. . . . text 0..1 string Note explanatory text
. . . . language 0..1 CodeableConcept Language if different from the resource
Common Languages (Extensible but limited to All Languages)
. . . communicationRequest 0..* Reference(CommunicationRequest) Request for additional information
. . . insurance 0..* BackboneElement Insurance or medical plan
. . . . sequence 1..1 positiveInt Service instance identifier
. . . . focal 1..1 boolean Is the focal Coverage
. . . . coverage 1..1 Reference(Coverage) Insurance information
. . . . businessArrangement 0..1 string Business agreement
. . . . preAuthRef 0..* string Pre-Authorization/Determination Reference
. . . . claimResponse 0..1 Reference(ClaimResponse) Adjudication results

doco Documentation for this format
Name Flags Card. Type Description & Constraints doco
. . ClinicalImpression DomainResource A clinical assessment performed when planning treatments and management strategies for a patient
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
. . . identifier Σ 0..* Identifier Business identifier
. . . status ?! Σ 1..1 code draft | completed | entered-in-error
ClinicalImpressionStatus (Required)
. . . code Σ 0..1 CodeableConcept Kind of assessment performed
. . . description Σ 0..1 string Why/how the assessment was performed
. . . subject Σ 1..1 Reference(Patient | Group) Patient or group assessed
. . . context Σ 0..1 Reference(Encounter | EpisodeOfCare) Encounter or Episode created from
. . . effective[x] Σ 0..1 Time of assessment
. . . . effectiveDateTime dateTime
. . . . effectivePeriod Period
. . . date Σ 0..1 dateTime When the assessment was documented
. . . assessor Σ 0..1 Reference(Practitioner) The clinician performing the assessment
. . . previous 0..1 Reference(ClinicalImpression) Reference to last assessment
. . . problem Σ 0..* Reference(Condition | AllergyIntolerance) Relevant impressions of patient state
. . . investigation 0..* BackboneElement One or more sets of investigations (signs, symptions, etc.)
. . . . code 1..1 CodeableConcept A name/code for the set
Investigation Type (Example)
. . . . item 0..* Reference(Observation | QuestionnaireResponse | FamilyMemberHistory | DiagnosticReport | RiskAssessment | ImagingStudy) Record of a specific investigation
. . . protocol 0..* uri Clinical Protocol followed
. . . summary 0..1 string Summary of the assessment
. . . finding 0..* BackboneElement Possible or likely findings and diagnoses
. . . . item[x] 1..1 What was found
Condition/Problem/Diagnosis Codes (Example)
. . . . . itemCodeableConcept CodeableConcept
. . . . . itemReference Reference(Condition | Observation)
. . . . basis 0..1 string Which investigations support finding
. . . prognosisCodeableConcept 0..* CodeableConcept Estimate of likely outcome
Clinical Impression Prognosis (Example)
. . . prognosisReference 0..* Reference(RiskAssessment) RiskAssessment expressing likely outcome
. . . action 0..* Reference(ReferralRequest | ProcedureRequest | Procedure | MedicationRequest | Appointment) Action taken as part of assessment procedure
. . . note 0..* Annotation Comments made about the ClinicalImpression

doco Documentation for this format
Name Flags Card. Type Description & Constraints doco
. . CodeSystem I DomainResource A set of codes drawn from one or more code systems
+ Within a code system definition, all the codes SHALL be unique
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
. . . url Σ 0..1 uri Logical URI to reference this code system (globally unique) (Coding.system)
. . . identifier Σ 0..1 Identifier Additional identifier for the code system
. . . version Σ 0..1 string Business version of the code system (Coding.version)
. . . name Σ 0..1 string Name for this code system (computer friendly)
. . . title Σ 0..1 string Name for this code system (human friendly)
. . . status ?! Σ 1..1 code draft | active | retired | unknown
PublicationStatus (Required)
. . . experimental ?! Σ 0..1 boolean For testing purposes, not real usage
. . . date Σ 0..1 dateTime Date this was last changed
. . . publisher Σ 0..1 string Name of the publisher (organization or individual)
. . . contact Σ 0..* ContactDetail Contact details for the publisher
. . . description 0..1 markdown Natural language description of the code system
. . . useContext Σ 0..* UsageContext Context the content is intended to support
. . . jurisdiction Σ 0..* CodeableConcept Intended jurisdiction for code system (if applicable)
Jurisdiction ValueSet (Extensible)
. . . purpose 0..1 markdown Why this code system is defined
. . . copyright 0..1 markdown Use and/or publishing restrictions
. . . caseSensitive Σ 0..1 boolean If code comparison is case sensitive
. . . valueSet Σ 0..1 uri Canonical URL for value set with entire code system
. . . hierarchyMeaning Σ 0..1 code grouped-by | is-a | part-of | classified-with
CodeSystemHierarchyMeaning (Required)
. . . compositional Σ 0..1 boolean If code system defines a post-composition grammar
. . . versionNeeded Σ 0..1 boolean If definitions are not stable
. . . content Σ 1..1 code not-present | example | fragment | complete
CodeSystemContentMode (Required)
. . . count Σ 0..1 unsignedInt Total concepts in the code system
. . . filter Σ 0..* BackboneElement Filter that can be used in a value set
. . . . code Σ 1..1 code Code that identifies the filter
. . . . description Σ 0..1 string How or why the filter is used
. . . . operator Σ 1..* code Operators that can be used with filter
FilterOperator (Required)
. . . . value Σ 1..1 string What to use for the value
. . . property Σ 0..* BackboneElement Additional information supplied about each concept
. . . . code Σ 1..1 code Identifies the property on the concepts, and when referred to in operations
. . . . uri Σ 0..1 uri Formal identifier for the property
. . . . description Σ 0..1 string Why the property is defined, and/or what it conveys
. . . . type Σ 1..1 code code | Coding | string | integer | boolean | dateTime
PropertyType (Required)
. . . concept 0..* BackboneElement Concepts in the code system
. . . . code 1..1 code Code that identifies concept
. . . . display 0..1 string Text to display to the user
. . . . definition 0..1 string Formal definition
. . . . designation 0..* BackboneElement Additional representations for the concept
. . . . . language 0..1 code Human language of the designation
Common Languages (Extensible but limited to All Languages)
. . . . . use 0..1 Coding Details how this designation would be used
Designation Use (Extensible)
. . . . . value 1..1 string The text value for this designation
. . . . property 0..* BackboneElement Property value for the concept
. . . . . code 1..1 code Reference to CodeSystem.property.code
. . . . . value[x] 1..1 Value of the property for this concept
. . . . . . valueCode code
. . . . . . valueCoding Coding
. . . . . . valueString string
. . . . . . valueInteger integer
. . . . . . valueBoolean boolean
. . . . . . valueDateTime dateTime
. . . . concept 0..* see concept Child Concepts (is-a/contains/categorizes)

doco Documentation for this format
Name Flags Card. Type Description & Constraints doco
. . Communication I DomainResource A record of information transmitted from a sender to a receiver
+ Not Done Reason can only be specified if NotDone is "true"
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
. . . identifier Σ 0..* Identifier Unique identifier
. . . definition Σ 0..* Reference(PlanDefinition | ActivityDefinition) Instantiates protocol or definition
. . . basedOn Σ 0..* Reference(Any) Request fulfilled by this communication
. . . partOf Σ 0..* Reference(Any) Part of this action
. . . status ?! Σ 1..1 code preparation | in-progress | suspended | aborted | completed | entered-in-error
EventStatus (Required)
. . . notDone ?! Σ 0..1 boolean Communication did not occur
. . . notDoneReason Σ I 0..1 CodeableConcept Why communication did not occur
CommunicationNotDoneReason (Example)
. . . category 0..* CodeableConcept Message category
CommunicationCategory (Example)
. . . medium 0..* CodeableConcept A channel of communication
v3 Code System ParticipationMode (Example)
. . . subject Σ 0..1 Reference(Patient | Group) Focus of message
. . . recipient 0..* Reference(Device | Organization | Patient | Practitioner | RelatedPerson | Group) Message recipient
. . . topic 0..* Reference(Any) Focal resources
. . . context Σ 0..1 Reference(Encounter | EpisodeOfCare) Encounter or episode leading to message
. . . sent 0..1 dateTime When sent
. . . received 0..1 dateTime When received
. . . sender 0..1 Reference(Device | Organization | Patient | Practitioner | RelatedPerson) Message sender
. . . reasonCode Σ 0..* CodeableConcept Indication for message
SNOMED CT Clinical Findings (Example)
. . . reasonReference Σ 0..* Reference(Condition | Observation) Why was communication done?
. . . payload 0..* BackboneElement Message payload
. . . . content[x] 1..1 Message part content
. . . . . contentString string
. . . . . contentAttachment Attachment
. . . . . contentReference Reference(Any)
. . . note 0..* Annotation Comments made about the communication

doco Documentation for this format
Name Flags Card. Type Description & Constraints doco
. . CommunicationRequest DomainResource A request for information to be sent to a receiver
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
. . . identifier Σ 0..* Identifier Unique identifier
. . . basedOn Σ 0..* Reference(Any) Fulfills plan or proposal
. . . replaces Σ 0..* Reference(CommunicationRequest) Request(s) replaced by this request
. . . groupIdentifier Σ 0..1 Identifier Composite request this is part of
. . . status ?! Σ 1..1 code draft | active | suspended | cancelled | completed | entered-in-error | unknown
RequestStatus (Required)
. . . category 0..* CodeableConcept Message category
CommunicationCategory (Example)
. . . priority Σ 0..1 code Message urgency
RequestPriority (Required)
. . . medium 0..* CodeableConcept A channel of communication
v3 Code System ParticipationMode (Example)
. . . subject 0..1 Reference(Patient | Group) Focus of message
. . . recipient 0..* Reference(Device | Organization | Patient | Practitioner | RelatedPerson | Group | CareTeam) Message recipient
. . . topic 0..* Reference(Any) Focal resources
. . . context Σ 0..1 Reference(Encounter | EpisodeOfCare) Encounter or episode leading to message
. . . payload 0..* BackboneElement Message payload
. . . . content[x] 1..1 Message part content
. . . . . contentString string
. . . . . contentAttachment Attachment
. . . . . contentReference Reference(Any)
. . . occurrence[x] Σ 0..1 When scheduled
. . . . occurrenceDateTime dateTime
. . . . occurrencePeriod Period
. . . authoredOn Σ 0..1 dateTime When request transitioned to being actionable
. . . sender 0..1 Reference(Device | Organization | Patient | Practitioner | RelatedPerson) Message sender
. . . requester Σ I 0..1 BackboneElement Who/what is requesting service
+ onBehalfOf can only be specified if agent is practitioner or device
. . . . agent Σ 1..1 Reference(Practitioner | Organization | Patient | RelatedPerson | Device) Individual making the request
. . . . onBehalfOf Σ I 0..1 Reference(Organization) Organization agent is acting for
. . . reasonCode Σ 0..* CodeableConcept Why is communication needed?
v3 Code System ActReason (Example)
. . . reasonReference Σ 0..* Reference(Condition | Observation) Why is communication needed?
. . . note 0..* Annotation Comments made about communication request

doco Documentation for this format
Name Flags Card. Type Description & Constraints doco
. . CompartmentDefinition DomainResource Compartment Definition for a resource
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
. . . url Σ 1..1 uri Logical URI to reference this compartment definition (globally unique)
. . . name Σ 1..1 string Name for this compartment definition (computer friendly)
. . . title Σ 0..1 string Name for this compartment definition (human friendly)
. . . status ?! Σ 1..1 code draft | active | retired | unknown
PublicationStatus (Required)
. . . experimental ?! Σ 0..1 boolean For testing purposes, not real usage
. . . date Σ 0..1 dateTime Date this was last changed
. . . publisher Σ 0..1 string Name of the publisher (organization or individual)
. . . contact Σ 0..* ContactDetail Contact details for the publisher
. . . description 0..1 markdown Natural language description of the compartment definition
. . . purpose 0..1 markdown Why this compartment definition is defined
. . . useContext Σ 0..* UsageContext Context the content is intended to support
. . . jurisdiction Σ 0..* CodeableConcept Intended jurisdiction for compartment definition (if applicable)
Jurisdiction ValueSet (Extensible)
. . . code Σ 1..1 code Patient | Encounter | RelatedPerson | Practitioner | Device
CompartmentType (Required)
. . . search Σ 1..1 boolean Whether the search syntax is supported
. . . resource Σ 0..* BackboneElement How a resource is related to the compartment
. . . . code Σ 1..1 code Name of resource type
ResourceType (Required)
. . . . param Σ 0..* string Search Parameter Name, or chained parameters
. . . . documentation 0..1 string Additional documentation about the resource and compartment

doco Documentation for this format
Name Flags Card. Type Description & Constraints doco
. . Composition DomainResource A set of resources composed into a single coherent clinical statement with clinical attestation
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
. . . identifier Σ 0..1 Identifier Logical identifier of composition (version-independent)
. . . status ?! Σ 1..1 code preliminary | final | amended | entered-in-error
CompositionStatus (Required)
. . . type Σ 1..1 CodeableConcept Kind of composition (LOINC if possible)
FHIR Document Type Codes (Preferred)
. . . class Σ 0..1 CodeableConcept Categorization of Composition
FHIR Document Class Codes (Example)
. . . subject Σ 1..1 Reference(Any) Who and/or what the composition is about
. . . encounter Σ 0..1 Reference(Encounter) Context of the Composition
. . . date Σ 1..1 dateTime Composition editing time
. . . author Σ 1..* Reference(Practitioner | Device | Patient | RelatedPerson) Who and/or what authored the composition
. . . title Σ 1..1 string Human Readable name/title
. . . confidentiality ?! Σ 0..1 code As defined by affinity domain
ConfidentialityClassification (Required)
. . . attester Σ 0..* BackboneElement Attests to accuracy of composition
. . . . mode Σ 1..* code personal | professional | legal | official
CompositionAttestationMode (Required)
. . . . time Σ 0..1 dateTime When the composition was attested
. . . . party Σ 0..1 Reference(Patient | Practitioner | Organization) Who attested the composition
. . . custodian Σ 0..1 Reference(Organization) Organization which maintains the composition
. . . relatesTo Σ 0..* BackboneElement Relationships to other compositions/documents
. . . . code Σ 1..1 code replaces | transforms | signs | appends
DocumentRelationshipType (Required)
. . . . target[x] Σ 1..1 Target of the relationship
. . . . . targetIdentifier Identifier
. . . . . targetReference Reference(Composition)
. . . event Σ 0..* BackboneElement The clinical service(s) being documented
. . . . code Σ 0..* CodeableConcept Code(s) that apply to the event being documented
v3 Code System ActCode (Example)
. . . . period Σ 0..1 Period The period covered by the documentation
. . . . detail Σ 0..* Reference(Any) The event(s) being documented
. . . section I 0..* BackboneElement Composition is broken into sections
+ A section must at least one of text, entries, or sub-sections
+ A section can only have an emptyReason if it is empty
. . . . title 0..1 string Label for section (e.g. for ToC)
. . . . code 0..1 CodeableConcept Classification of section (recommended)
Document Section Codes (Example)
. . . . text I 0..1 Narrative Text summary of the section, for human interpretation
. . . . mode ?! Σ 0..1 code working | snapshot | changes
ListMode (Required)
. . . . orderedBy 0..1 CodeableConcept Order of section entries
List Order Codes (Preferred)
. . . . entry I 0..* Reference(Any) A reference to data that supports this section
. . . . emptyReason I 0..1 CodeableConcept Why the section is empty
List Empty Reasons (Preferred)
. . . . section I 0..* see section Nested Section

doco Documentation for this format
Name Flags Card. Type Description & Constraints doco
. . ConceptMap DomainResource A map from one set of concepts to one or more other concepts
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
. . . url Σ 0..1 uri Logical URI to reference this concept map (globally unique)
. . . identifier Σ 0..1 Identifier Additional identifier for the concept map
. . . version Σ 0..1 string Business version of the concept map
. . . name Σ 0..1 string Name for this concept map (computer friendly)
. . . title Σ 0..1 string Name for this concept map (human friendly)
. . . status ?! Σ 1..1 code draft | active | retired | unknown
PublicationStatus (Required)
. . . experimental ?! Σ 0..1 boolean For testing purposes, not real usage
. . . date Σ 0..1 dateTime Date this was last changed
. . . publisher Σ 0..1 string Name of the publisher (organization or individual)
. . . contact Σ 0..* ContactDetail Contact details for the publisher
. . . description 0..1 markdown Natural language description of the concept map
. . . useContext Σ 0..* UsageContext Context the content is intended to support
. . . jurisdiction Σ 0..* CodeableConcept Intended jurisdiction for concept map (if applicable)
Jurisdiction ValueSet (Extensible)
. . . purpose 0..1 markdown Why this concept map is defined
. . . copyright 0..1 markdown Use and/or publishing restrictions
. . . source[x] Σ 0..1 Identifies the source of the concepts which are being mapped
. . . . sourceUri uri
. . . . sourceReference Reference(ValueSet)
. . . target[x] Σ 0..1 Provides context to the mappings
. . . . targetUri uri
. . . . targetReference Reference(ValueSet)
. . . group 0..* BackboneElement Same source and target systems
. . . . source 0..1 uri Code System (if value set crosses code systems)
. . . . sourceVersion 0..1 string Specific version of the code system
. . . . target 0..1 uri System of the target (if necessary)
. . . . targetVersion 0..1 string Specific version of the code system
. . . . element 1..* BackboneElement Mappings for a concept from the source set
. . . . . code 0..1 code Identifies element being mapped
. . . . . display 0..1 string Display for the code
. . . . . target I 0..* BackboneElement Concept in target system for element
+ If the map is narrower or inexact, there SHALL be some comments
. . . . . . code 0..1 code Code that identifies the target element
. . . . . . display 0..1 string Display for the code
. . . . . . equivalence ?! 0..1 code relatedto | equivalent | equal | wider | subsumes | narrower | specializes | inexact | unmatched | disjoint
ConceptMapEquivalence (Required)
. . . . . . comment I 0..1 string Description of status/issues in mapping
. . . . . . dependsOn 0..* BackboneElement Other elements required for this mapping (from context)
. . . . . . . property 1..1 uri Reference to property mapping depends on
. . . . . . . system 0..1 uri Code System (if necessary)
. . . . . . . code 1..1 string Value of the referenced element
. . . . . . . display 0..1 string Display for the code
. . . . . . product 0..* see dependsOn Other concepts that this mapping also produces
. . . . unmapped I 0..1 BackboneElement When no match in the mappings
+ If the mode is 'other-map', a code must be provided
+ If the mode is 'fixed', a code must be provided
. . . . . mode 1..1 code provided | fixed | other-map
ConceptMapGroupUnmappedMode (Required)
. . . . . code 0..1 code Fixed code when mode = fixed
. . . . . display 0..1 string Display for the code
. . . . . url 0..1 uri Canonical URL for other concept map

doco Documentation for this format
Name Flags Card. Type Description & Constraints doco
. . Condition I DomainResource Detailed information about conditions, problems or diagnoses
+ If condition is abated, then clinicalStatus must be either inactive, resolved, or remission
+ Condition.clinicalStatus SHALL be present if verificationStatus is not entered-in-error
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
. . . identifier Σ 0..* Identifier External Ids for this condition
. . . clinicalStatus ?! Σ I 0..1 code active | recurrence | inactive | remission | resolved
Condition Clinical Status Codes (Required)
. . . verificationStatus ?! Σ I 0..1 code provisional | differential | confirmed | refuted | entered-in-error | unknown
ConditionVerificationStatus (Required)
. . . category 0..* CodeableConcept problem-list-item | encounter-diagnosis
Condition Category Codes (Example)
. . . severity 0..1 CodeableConcept Subjective severity of condition
Condition/Diagnosis Severity (Preferred)
. . . code Σ 0..1 CodeableConcept Identification of the condition, problem or diagnosis
Condition/Problem/Diagnosis Codes (Example)
. . . bodySite Σ 0..* CodeableConcept Anatomical location, if relevant
SNOMED CT Body Structures (Example)
. . . subject Σ 1..1 Reference(Patient | Group) Who has the condition?
. . . context Σ 0..1 Reference(Encounter | EpisodeOfCare) Encounter or episode when condition first asserted
. . . onset[x] Σ 0..1 Estimated or actual date, date-time, or age
. . . . onsetDateTime dateTime
. . . . onsetAge Age
. . . . onsetPeriod Period
. . . . onsetRange Range
. . . . onsetString string
. . . abatement[x] I 0..1 If/when in resolution/remission
. . . . abatementDateTime dateTime
. . . . abatementAge Age
. . . . abatementBoolean boolean
. . . . abatementPeriod Period
. . . . abatementRange Range
. . . . abatementString string
. . . assertedDate Σ 0..1 dateTime Date record was believed accurate
. . . asserter Σ 0..1 Reference(Practitioner | Patient | RelatedPerson) Person who asserts this condition
. . . stage I 0..1 BackboneElement Stage/grade, usually assessed formally
+ Stage SHALL have summary or assessment
. . . . summary I 0..1 CodeableConcept Simple summary (disease specific)
Condition Stage (Example)
. . . . assessment I 0..* Reference(ClinicalImpression | DiagnosticReport | Observation) Formal record of assessment
. . . evidence I 0..* BackboneElement Supporting evidence
+ evidence SHALL have code or details
. . . . code Σ I 0..* CodeableConcept Manifestation/symptom
Manifestation and Symptom Codes (Example)
. . . . detail Σ I 0..* Reference(Any) Supporting information found elsewhere
. . . note 0..* Annotation Additional information about the Condition

doco Documentation for this format
Name Flags Card. Type Description & Constraints doco
. . Consent I DomainResource A healthcare consumer's policy choices to permits or denies recipients or roles to perform actions for specific purposes and periods of time
+ Either a Policy or PolicyRule
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
. . . identifier Σ 0..1 Identifier Identifier for this record (external references)
. . . status ?! Σ 1..1 code draft | proposed | active | rejected | inactive | entered-in-error
ConsentState (Required)
. . . category Σ 0..* CodeableConcept Classification of the consent statement - for indexing/retrieval
Consent Category Codes (Example)
. . . patient Σ 1..1 Reference(Patient) Who the consent applies to
. . . period Σ 0..1 Period Period that this consent applies
. . . dateTime Σ 0..1 dateTime When this Consent was created or indexed
. . . consentingParty Σ 0..* Reference(Organization | Patient | Practitioner | RelatedPerson) Who is agreeing to the policy and exceptions
. . . actor Σ 0..* BackboneElement Who|what controlled by this consent (or group, by role)
. . . . role 1..1 CodeableConcept How the actor is involved
SecurityRoleType (Extensible)
. . . . reference 1..1 Reference(Device | Group | CareTeam | Organization | Patient | Practitioner | RelatedPerson) Resource for the actor (or group, by role)
. . . action Σ 0..* CodeableConcept Actions controlled by this consent
Consent Action Codes (Example)
. . . organization Σ 0..* Reference(Organization) Custodian of the consent
. . . source[x] Σ 0..1 Source from which this consent is taken
. . . . sourceAttachment Attachment
. . . . sourceIdentifier Identifier
. . . . sourceReference Reference(Consent | DocumentReference | Contract | QuestionnaireResponse)
. . . policy 0..* BackboneElement Policies covered by this consent
. . . . authority I 0..1 uri Enforcement source for policy
. . . . uri I 0..1 uri Specific policy covered by this consent
. . . policyRule Σ I 0..1 uri Policy that this consents to
. . . securityLabel Σ 0..* Coding Security Labels that define affected resources
All Security Labels (Extensible)
. . . purpose Σ 0..* Coding Context of activities for which the agreement is made
PurposeOfUse (Extensible)
. . . dataPeriod Σ 0..1 Period Timeframe for data controlled by this consent
. . . data Σ 0..* BackboneElement Data controlled by this consent
. . . . meaning Σ 1..1 code instance | related | dependents | authoredby
ConsentDataMeaning (Required)
. . . . reference Σ 1..1 Reference(Any) The actual data reference
. . . except Σ 0..* BackboneElement Additional rule - addition or removal of permissions
. . . . type Σ 1..1 code deny | permit
ConsentExceptType (Required)
. . . . period Σ 0..1 Period Timeframe for this exception
. . . . actor Σ 0..* BackboneElement Who|what controlled by this exception (or group, by role)
. . . . . role 1..1 CodeableConcept How the actor is involved
SecurityRoleType (Extensible)
. . . . . reference 1..1 Reference(Device | Group | CareTeam | Organization | Patient | Practitioner | RelatedPerson) Resource for the actor (or group, by role)
. . . . action Σ 0..* CodeableConcept Actions controlled by this exception
Consent Action Codes (Example)
. . . . securityLabel Σ 0..* Coding Security Labels that define affected resources
All Security Labels (Extensible)
. . . . purpose Σ 0..* Coding Context of activities covered by this exception
PurposeOfUse (Extensible)
. . . . class Σ 0..* Coding e.g. Resource Type, Profile, or CDA etc
Consent Content Class (Extensible)
. . . . code Σ 0..* Coding e.g. LOINC or SNOMED CT code, etc in the content
Consent Content Codes (Example)
. . . . dataPeriod Σ 0..1 Period Timeframe for data controlled by this exception
. . . . data Σ 0..* BackboneElement Data controlled by this exception
. . . . . meaning Σ 1..1 code instance | related | dependents | authoredby
ConsentDataMeaning (Required)
. . . . . reference Σ 1..1 Reference(Any) The actual data reference

doco Documentation for this format
Name Flags Card. Type Description & Constraints doco
. . Contract DomainResource Legal Agreement
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
. . . identifier Σ 0..1 Identifier Contract number
. . . status ?! Σ 0..1 code amended | appended | cancelled | disputed | entered-in-error | executable | executed | negotiable | offered | policy | rejected | renewed | revoked | resolved | terminated
Contract Resource Status Codes (Required)
. . . issued Σ 0..1 dateTime When this Contract was issued
. . . applies Σ 0..1 Period Effective time
. . . subject Σ 0..* Reference(Any) Contract Target Entity
. . . topic Σ 0..* Reference(Any) Context of the Contract
. . . authority 0..* Reference(Organization) Authority under which this Contract has standing
. . . domain 0..* Reference(Location) Domain in which this Contract applies
. . . type Σ 0..1 CodeableConcept Type or form
Contract Type Codes (Example)
. . . subType Σ 0..* CodeableConcept Subtype within the context of type
Contract Subtype Codes (Example)
. . . action 0..* CodeableConcept Action stipulated by this Contract
Contract Action Codes (Example)
. . . actionReason 0..* CodeableConcept Rationale for the stiplulated action
PurposeOfUse (Example)
. . . decisionType 0..1 CodeableConcept Decision by Grantor
ActConsentDirective (Extensible)
. . . contentDerivative 0..1 CodeableConcept Content derived from the basal information
Contract Content Derivation Codes (Example)
. . . securityLabel Σ 0..* Coding Security Labels that define affected resources
All Security Labels (Extensible)
. . . agent 0..* BackboneElement Entity being ascribed responsibility
. . . . actor 1..1 Reference(Contract | Device | Group | Location | Organization | Patient | Practitioner | RelatedPerson | Substance) Contract Agent Type
. . . . role 0..* CodeableConcept Role type of the agent
Contract Actor Role Codes (Example)
. . . signer 0..* BackboneElement Contract Signatory
. . . . type 1..1 Coding Contract Signatory Role
Contract Signer Type Codes (Preferred)
. . . . party 1..1 Reference(Organization | Patient | Practitioner | RelatedPerson) Contract Signatory Party
. . . . signature 1..* Signature Contract Documentation Signature
. . . valuedItem 0..* BackboneElement Contract Valued Item List
. . . . entity[x] 0..1 Contract Valued Item Type
. . . . . entityCodeableConcept CodeableConcept
. . . . . entityReference Reference(Any)
. . . . identifier 0..1 Identifier Contract Valued Item Number
. . . . effectiveTime 0..1 dateTime Contract Valued Item Effective Tiem
. . . . quantity 0..1 SimpleQuantity Count of Contract Valued Items
. . . . unitPrice 0..1 Money Contract Valued Item fee, charge, or cost
. . . . factor 0..1 decimal Contract Valued Item Price Scaling Factor
. . . . points 0..1 decimal Contract Valued Item Difficulty Scaling Factor
. . . . net 0..1 Money Total Contract Valued Item Value
. . . term 0..* BackboneElement Contract Term List
. . . . identifier Σ 0..1 Identifier Contract Term Number
. . . . issued Σ 0..1 dateTime Contract Term Issue Date Time
. . . . applies Σ 0..1 Period Contract Term Effective Time
. . . . type 0..1 CodeableConcept Contract Term Type or Form
Contract Term Type Codes (Example)
. . . . subType 0..1 CodeableConcept Contract Term Type specific classification
Contract Term Subtype Codes (Example)
. . . . topic Σ 0..* Reference(Any) Context of the Contract term
. . . . action 0..* CodeableConcept Contract Term Activity
Contract Action Codes (Example)
. . . . actionReason 0..* CodeableConcept Purpose for the Contract Term Action
PurposeOfUse (Example)
. . . . securityLabel Σ 0..* Coding Security Labels that define affected terms
All Security Labels (Extensible)
. . . . agent 0..* BackboneElement Contract Term Agent List
. . . . . actor 1..1 Reference(Contract | Device | Group | Location | Organization | Patient | Practitioner | RelatedPerson | Substance) Contract Term Agent Subject
. . . . . role 0..* CodeableConcept Type of the Contract Term Agent
Contract Actor Role Codes (Example)
. . . . text 0..1 string Human readable Contract term text
. . . . valuedItem 0..* BackboneElement Contract Term Valued Item List
. . . . . entity[x] 0..1 Contract Term Valued Item Type
. . . . . . entityCodeableConcept CodeableConcept
. . . . . . entityReference Reference(Any)
. . . . . identifier 0..1 Identifier Contract Term Valued Item Number
. . . . . effectiveTime 0..1 dateTime Contract Term Valued Item Effective Tiem
. . . . . quantity 0..1 SimpleQuantity Contract Term Valued Item Count
. . . . . unitPrice 0..1 Money Contract Term Valued Item fee, charge, or cost
. . . . . factor 0..1 decimal Contract Term Valued Item Price Scaling Factor
. . . . . points 0..1 decimal Contract Term Valued Item Difficulty Scaling Factor
. . . . . net 0..1 Money Total Contract Term Valued Item Value
. . . . group 0..* see term Nested Contract Term Group
. . . binding[x] 0..1 Binding Contract
. . . . bindingAttachment Attachment
. . . . bindingReference Reference(Composition | DocumentReference | QuestionnaireResponse)
. . . friendly 0..* BackboneElement Contract Friendly Language
. . . . content[x] 1..1 Easily comprehended representation of this Contract
. . . . . contentAttachment Attachment
. . . . . contentReference Reference(Composition | DocumentReference | QuestionnaireResponse)
. . . legal 0..* BackboneElement Contract Legal Language
. . . . content[x] 1..1 Contract Legal Text
. . . . . contentAttachment Attachment
. . . . . contentReference Reference(Composition | DocumentReference | QuestionnaireResponse)
. . . rule 0..* BackboneElement Computable Contract Language
. . . . content[x] 1..1 Computable Contract Rules
. . . . . contentAttachment Attachment
. . . . . contentReference Reference(DocumentReference)

doco Documentation for this format
Name Flags Card. Type Description & Constraints doco
. . Coverage DomainResource Insurance or medical plan or a payment agreement
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
. . . identifier Σ 0..* Identifier The primary coverage ID
. . . status ?! Σ 0..1 code active | cancelled | draft | entered-in-error
Financial Resource Status Codes (Required)
. . . type Σ 0..1 CodeableConcept Type of coverage such as medical or accident
Coverage Type and Self-Pay Codes (Preferred)
. . . policyHolder Σ 0..1 Reference(Patient | RelatedPerson | Organization) Owner of the policy
. . . subscriber Σ 0..1 Reference(Patient | RelatedPerson) Subscriber to the policy
. . . subscriberId Σ 0..1 string ID assigned to the Subscriber
. . . beneficiary Σ 0..1 Reference(Patient) Plan Beneficiary
. . . relationship 0..1 CodeableConcept Beneficiary relationship to the Subscriber
Policyholder Relationship Codes (Example)
. . . period Σ 0..1 Period Coverage start and end dates
. . . payor Σ 0..* Reference(Organization | Patient | RelatedPerson) Identifier for the plan or agreement issuer
. . . grouping 0..1 BackboneElement Additional coverage classifications
. . . . group Σ 0..1 string An identifier for the group
. . . . groupDisplay Σ 0..1 string Display text for an identifier for the group
. . . . subGroup Σ 0..1 string An identifier for the subsection of the group
. . . . subGroupDisplay Σ 0..1 string Display text for the subsection of the group
. . . . plan Σ 0..1 string An identifier for the plan
. . . . planDisplay Σ 0..1 string Display text for the plan
. . . . subPlan Σ 0..1 string An identifier for the subsection of the plan
. . . . subPlanDisplay Σ 0..1 string Display text for the subsection of the plan
. . . . class Σ 0..1 string An identifier for the class
. . . . classDisplay Σ 0..1 string Display text for the class
. . . . subClass Σ 0..1 string An identifier for the subsection of the class
. . . . subClassDisplay Σ 0..1 string Display text for the subsection of the subclass
. . . dependent Σ 0..1 string Dependent number
. . . sequence Σ 0..1 string The plan instance or sequence counter
. . . order Σ 0..1 positiveInt Relative order of the coverage
. . . network Σ 0..1 string Insurer network
. . . contract 0..* Reference(Contract) Contract details

doco Documentation for this format
Name Flags Card. Type Description & Constraints doco
. . DataElement DomainResource Resource data element
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
. . . url Σ 0..1 uri Logical URI to reference this data element (globally unique)
. . . identifier Σ 0..* Identifier Additional identifier for the data element
. . . version Σ 0..1 string Business version of the data element
. . . status ?! Σ 1..1 code draft | active | retired | unknown
PublicationStatus (Required)
. . . experimental ?! Σ 0..1 boolean For testing purposes, not real usage
. . . date Σ 0..1 dateTime Date this was last changed
. . . publisher Σ 0..1 string Name of the publisher (organization or individual)
. . . name Σ 0..1 string Name for this data element (computer friendly)
. . . title Σ 0..1 string Name for this data element (human friendly)
. . . contact Σ 0..* ContactDetail Contact details for the publisher
. . . useContext Σ 0..* UsageContext Context the content is intended to support
. . . jurisdiction Σ 0..* CodeableConcept Intended jurisdiction for data element (if applicable)
Jurisdiction ValueSet (Extensible)
. . . copyright 0..1 markdown Use and/or publishing restrictions
. . . stringency Σ 0..1 code comparable | fully-specified | equivalent | convertable | scaleable | flexible
DataElementStringency (Required)
. . . mapping I 0..* BackboneElement External specification mapped to
+ At least one of name or uri SHALL be present
. . . . identity 1..1 id Internal id when this mapping is used
. . . . uri 0..1 uri Identifies what this mapping refers to
. . . . name 0..1 string Names what this mapping refers to
. . . . comment 0..1 string Versions, issues, scope limitations, etc.
. . . element Σ I 1..* ElementDefinition Definition of element
+ No base allowed
+ No slicing allowed

doco Documentation for this format
Name Flags Card. Type Description & Constraints doco
. . DetectedIssue DomainResource Clinical issue with action
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
. . . identifier Σ 0..1 Identifier Unique id for the detected issue
. . . status ?! Σ 1..1 code registered | preliminary | final | amended +
ObservationStatus (Required)
. . . category Σ 0..1 CodeableConcept Issue Category, e.g. drug-drug, duplicate therapy, etc.
Detected Issue Category (Preferred)
. . . severity Σ 0..1 code high | moderate | low
DetectedIssueSeverity (Required)
. . . patient Σ 0..1 Reference(Patient) Associated patient
. . . date Σ 0..1 dateTime When identified
. . . author Σ 0..1 Reference(Practitioner | Device) The provider or device that identified the issue
. . . implicated Σ 0..* Reference(Any) Problem resource
. . . detail 0..1 string Description and context
. . . reference 0..1 uri Authority for issue
. . . mitigation 0..* BackboneElement Step taken to address
. . . . action 1..1 CodeableConcept What mitigation?
Detected Issue Mitigation Action (Preferred)
. . . . date 0..1 dateTime Date committed
. . . . author 0..1 Reference(Practitioner) Who is committing?

doco Documentation for this format
Name Flags Card. Type Description & Constraints doco
. . Device DomainResource Item used in healthcare
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
. . . identifier 0..* Identifier Instance identifier
. . . udi Σ 0..1 BackboneElement Unique Device Identifier (UDI) Barcode string
. . . . deviceIdentifier Σ 0..1 string Mandatory fixed portion of UDI
. . . . name Σ 0..1 string Device Name as appears on UDI label
. . . . jurisdiction 0..1 uri Regional UDI authority
. . . . carrierHRF Σ 0..1 string UDI Human Readable Barcode String
. . . . carrierAIDC Σ 0..1 base64Binary UDI Machine Readable Barcode String
. . . . issuer 0..1 uri UDI Issuing Organization
. . . . entryType 0..1 code barcode | rfid | manual +
UDIEntryType (Required)
. . . status ?! Σ 0..1 code active | inactive | entered-in-error | unknown
FHIRDeviceStatus (Required)
. . . type 0..1 CodeableConcept What kind of device this is
FHIR Device Types (Example)
. . . lotNumber 0..1 string Lot number of manufacture
. . . manufacturer 0..1 string Name of device manufacturer
. . . manufactureDate 0..1 dateTime Date when the device was made
. . . expirationDate 0..1 dateTime Date and time of expiry of this device (if applicable)
. . . model 0..1 string Model id assigned by the manufacturer
. . . version 0..1 string Version number (i.e. software)
. . . patient 0..1 Reference(Patient) Patient to whom Device is affixed
. . . owner 0..1 Reference(Organization) Organization responsible for device
. . . contact 0..* ContactPoint Details for human/organization for support
. . . location 0..1 Reference(Location) Where the resource is found
. . . url 0..1 uri Network address to contact device
. . . note 0..* Annotation Device notes and comments
. . . safety Σ 0..* CodeableConcept Safety Characteristics of Device
DeviceSafety (Example)

doco Documentation for this format
Name Flags Card. Type Description & Constraints doco
. . DeviceComponent Σ DomainResource An instance of a medical-related component of a medical device
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
. . . identifier Σ 1..1 Identifier Instance id assigned by the software stack
. . . type Σ 1..1 CodeableConcept What kind of component it is
FHIR Device Types (Preferred)
. . . lastSystemChange Σ 0..1 instant Recent system change timestamp
. . . source Σ 0..1 Reference(Device) Top-level device resource link
. . . parent Σ 0..1 Reference(DeviceComponent) Parent resource link
. . . operationalStatus Σ 0..* CodeableConcept Current operational status of the component, for example On, Off or Standby
DeviceComponentOperationalStatus (Extensible)
. . . parameterGroup Σ 0..1 CodeableConcept Current supported parameter group
DeviceComponentParameterGroup (Extensible)
. . . measurementPrinciple Σ 0..1 code other | chemical | electrical | impedance | nuclear | optical | thermal | biological | mechanical | acoustical | manual+
MeasmntPrinciple (Required)
. . . productionSpecification Σ 0..* BackboneElement Specification details such as Component Revisions, or Serial Numbers
. . . . specType Σ 0..1 CodeableConcept Type or kind of production specification, for example serial number or software revision
DeviceSpecificationSpecType (Extensible)
. . . . componentId Σ 0..1 Identifier Internal component unique identification
. . . . productionSpec Σ 0..1 string A printable string defining the component
. . . languageCode Σ 0..1 CodeableConcept Language code for the human-readable text strings produced by the device
Common Languages (Extensible but limited to All Languages)

doco Documentation for this format
Name Flags Card. Type Description & Constraints doco
. . DeviceMetric Σ DomainResource Measurement, calculation or setting capability of a medical device
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
. . . identifier Σ 1..1 Identifier Unique identifier of this DeviceMetric
. . . type Σ 1..1 CodeableConcept Identity of metric, for example Heart Rate or PEEP Setting
Device Metric and Component Types (Preferred)
. . . unit Σ 0..1 CodeableConcept Unit of Measure for the Metric
Device Metric and Component Types (Preferred)
. . . source Σ 0..1 Reference(Device) Describes the link to the source Device
. . . parent Σ 0..1 Reference(DeviceComponent) Describes the link to the parent DeviceComponent
. . . operationalStatus Σ 0..1 code on | off | standby | entered-in-error
DeviceMetricOperationalStatus (Required)
. . . color Σ 0..1 code black | red | green | yellow | blue | magenta | cyan | white
DeviceMetricColor (Required)
. . . category Σ 1..1 code measurement | setting | calculation | unspecified
DeviceMetricCategory (Required)
. . . measurementPeriod Σ 0..1 Timing Describes the measurement repetition time
. . . calibration Σ 0..* BackboneElement Describes the calibrations that have been performed or that are required to be performed
. . . . type Σ 0..1 code unspecified | offset | gain | two-point
DeviceMetricCalibrationType (Required)
. . . . state Σ 0..1 code not-calibrated | calibration-required | calibrated | unspecified
DeviceMetricCalibrationState (Required)
. . . . time Σ 0..1 instant Describes the time last calibration has been performed

doco Documentation for this format
Name Flags Card. Type Description & Constraints doco
. . DeviceRequest DomainResource Medical device request
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
. . . identifier Σ 0..* Identifier External Request identifier
. . . definition Σ 0..* Reference(ActivityDefinition | PlanDefinition) Protocol or definition
. . . basedOn Σ 0..* Reference(Any) What request fulfills
. . . priorRequest Σ 0..* Reference(Any) What request replaces
. . . groupIdentifier Σ 0..1 Identifier Identifier of composite request
. . . status ?! Σ 0..1 code draft | active | suspended | completed | entered-in-error | cancelled
RequestStatus (Required)
. . . intent ?! Σ 1..1 CodeableConcept proposal | plan | original-order | encoded | reflex-order
RequestIntent (Required)
. . . priority Σ 0..1 code Indicates how quickly the {{title}} should be addressed with respect to other requests
RequestPriority (Required)
. . . code[x] Σ 1..1 Device requested
FHIR Device Types (Example)
. . . . codeReference Reference(Device)
. . . . codeCodeableConcept CodeableConcept
. . . subject Σ 1..1 Reference(Patient | Group | Location | Device) Focus of request
. . . context Σ 0..1 Reference(Encounter | EpisodeOfCare) Encounter or Episode motivating request
. . . occurrence[x] Σ 0..1 Desired time or schedule for use
. . . . occurrenceDateTime dateTime
. . . . occurrencePeriod Period
. . . . occurrenceTiming Timing
. . . authoredOn Σ 0..1 dateTime When recorded
. . . requester Σ 0..1 BackboneElement Who/what is requesting diagnostics
. . . . agent Σ 1..1 Reference(Device | Practitioner | Organization) Individual making the request
. . . . onBehalfOf Σ 0..1 Reference(Organization) Organization agent is acting for
. . . performerType Σ 0..1 CodeableConcept Fille role
Participant Roles (Example)
. . . performer Σ 0..1 Reference(Practitioner | Organization | Patient | Device | RelatedPerson | HealthcareService) Requested Filler
. . . reasonCode Σ 0..* CodeableConcept Coded Reason for request
Condition/Problem/Diagnosis Codes (Example)
. . . reasonReference Σ 0..* Reference(Any) Linked Reason for request
. . . supportingInfo 0..* Reference(Any) Additional clinical information
. . . note 0..* Annotation Notes or comments
. . . relevantHistory 0..* Reference(Provenance) Request provenance

doco Documentation for this format
Name Flags Card. Type Description & Constraints doco
. . DeviceUseStatement DomainResource Record of use of a device
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
. . . identifier 0..* Identifier External identifier for this record
. . . status ?! Σ 1..1 code active | completed | entered-in-error +
DeviceUseStatementStatus (Required)
. . . subject 1..1 Reference(Patient | Group) Patient using device
. . . whenUsed 0..1 Period Period device was used
. . . timing[x] 0..1 How often the device was used
. . . . timingTiming Timing
. . . . timingPeriod Period
. . . . timingDateTime dateTime
. . . recordedOn 0..1 dateTime When statement was recorded
. . . source 0..1 Reference(Patient | Practitioner | RelatedPerson) Who made the statement
. . . device 1..1 Reference(Device) Reference to device used
. . . indication 0..* CodeableConcept Why device was used
. . . bodySite 0..1 CodeableConcept Target body site
SNOMED CT Body Structures (Example)
. . . note 0..* Annotation Addition details (comments, instructions)

doco Documentation for this format
Name Flags Card. Type Description & Constraints doco
. . DiagnosticReport DomainResource A Diagnostic report - a combination of request information, atomic results, images, interpretation, as well as formatted reports
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
. . . identifier Σ 0..* Identifier Business identifier for report
. . . basedOn 0..* Reference(CarePlan | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ProcedureRequest | ReferralRequest) What was requested
. . . status ?! Σ 1..1 code registered | partial | preliminary | final +
DiagnosticReportStatus (Required)
. . . category Σ 0..1 CodeableConcept Service category
Diagnostic Service Section Codes (Example)
. . . code Σ 1..1 CodeableConcept Name/Code for this diagnostic report
LOINC Diagnostic Report Codes (Preferred)
. . . subject Σ 0..1 Reference(Patient | Group | Device | Location) The subject of the report - usually, but not always, the patient
. . . context Σ 0..1 Reference(Encounter | EpisodeOfCare) Health care event when test ordered
. . . effective[x] Σ 0..1 Clinically relevant time/time-period for report
. . . . effectiveDateTime dateTime
. . . . effectivePeriod Period
. . . issued Σ 0..1 instant DateTime this version was released
. . . performer Σ 0..* BackboneElement Participants in producing the report
. . . . role Σ 0..1 CodeableConcept Type of performer
Procedure Performer Role Codes (Example)
. . . . actor Σ 1..1 Reference(Practitioner | Organization) Practitioner or Organization participant
. . . specimen 0..* Reference(Specimen) Specimens this report is based on
. . . result 0..* Reference(Observation) Observations - simple, or complex nested groups
. . . imagingStudy 0..* Reference(ImagingStudy | ImagingManifest) Reference to full details of imaging associated with the diagnostic report
. . . image Σ 0..* BackboneElement Key images associated with this report
. . . . comment 0..1 string Comment about the image (e.g. explanation)
. . . . link Σ 1..1 Reference(Media) Reference to the image source
. . . conclusion 0..1 string Clinical Interpretation of test results
. . . codedDiagnosis 0..* CodeableConcept Codes for the conclusion
SNOMED CT Clinical Findings (Example)
. . . presentedForm 0..* Attachment Entire report as issued

doco Documentation for this format
Name Flags Card. Type Description & Constraints doco
. . DocumentManifest Σ DomainResource A list that defines a set of documents
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
. . . masterIdentifier Σ 0..1 Identifier Unique Identifier for the set of documents
. . . identifier Σ 0..* Identifier Other identifiers for the manifest
. . . status ?! Σ 1..1 code current | superseded | entered-in-error
DocumentReferenceStatus (Required)
. . . type Σ 0..1 CodeableConcept Kind of document set
Document Type Value Set (Preferred)
. . . subject Σ 0..1 Reference(Patient | Practitioner | Group | Device) The subject of the set of documents
. . . created Σ 0..1 dateTime When this document manifest created
. . . author Σ 0..* Reference(Practitioner | Organization | Device | Patient | RelatedPerson) Who and/or what authored the manifest
. . . recipient Σ 0..* Reference(Patient | Practitioner | RelatedPerson | Organization) Intended to get notified about this set of documents
. . . source Σ 0..1 uri The source system/application/software
. . . description Σ 0..1 string Human-readable description (title)
. . . content Σ 1..* BackboneElement The items included
. . . . p[x] Σ 1..1 Contents of this set of documents
. . . . . pAttachment Attachment
. . . . . pReference Reference(Any)
. . . related Σ 0..* BackboneElement Related things
. . . . identifier Σ 0..1 Identifier Identifiers of things that are related
. . . . ref Σ 0..1 Reference(Any) Related Resource

doco Documentation for this format
Name Flags Card. Type Description & Constraints doco
. . DocumentReference DomainResource A reference to a document
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
. . . masterIdentifier Σ 0..1 Identifier Master Version Specific Identifier
. . . identifier Σ 0..* Identifier Other identifiers for the document
. . . status ?! Σ 1..1 code current | superseded | entered-in-error
DocumentReferenceStatus (Required)
. . . docStatus Σ 0..1 code preliminary | final | appended | amended | entered-in-error
CompositionStatus (Required)
. . . type Σ 1..1 CodeableConcept Kind of document (LOINC if possible)
Document Type Value Set (Preferred)
. . . class Σ 0..1 CodeableConcept Categorization of document
Document Class Value Set (Example)
. . . subject Σ 0..1 Reference(Patient | Practitioner | Group | Device) Who/what is the subject of the document
. . . created Σ 0..1 dateTime Document creation time
. . . indexed Σ 1..1 instant When this document reference was created
. . . author Σ 0..* Reference(Practitioner | Organization | Device | Patient | RelatedPerson) Who and/or what authored the document
. . . authenticator Σ 0..1 Reference(Practitioner | Organization) Who/what authenticated the document
. . . custodian Σ 0..1 Reference(Organization) Organization which maintains the document
. . . relatesTo ?! Σ 0..* BackboneElement Relationships to other documents
. . . . code Σ 1..1 code replaces | transforms | signs | appends
DocumentRelationshipType (Required)
. . . . target Σ 1..1 Reference(DocumentReference) Target of the relationship
. . . description Σ 0..1 string Human-readable description (title)
. . . securityLabel Σ 0..* CodeableConcept Document security-tags
All Security Labels (Extensible)
. . . content Σ 1..* BackboneElement Document referenced
. . . . attachment Σ 1..1 Attachment Where to access the document
. . . . format Σ 0..1 Coding Format/content rules for the document
DocumentReference Format Code Set (Preferred)
. . . context Σ 0..1 BackboneElement Clinical context of document
. . . . encounter Σ 0..1 Reference(Encounter) Context of the document content
. . . . event Σ 0..* CodeableConcept Main clinical acts documented
v3 Code System ActCode (Example)
. . . . period Σ 0..1 Period Time of service that is being documented
. . . . facilityType Σ 0..1 CodeableConcept Kind of facility where patient was seen
Facility Type Code Value Set (Example)
. . . . practiceSetting Σ 0..1 CodeableConcept Additional details about where the content was created (e.g. clinical specialty)
Practice Setting Code Value Set (Example)
. . . . sourcePatientInfo Σ 0..1 Reference(Patient) Patient demographics from source
. . . . related Σ 0..* BackboneElement Related identifiers or resources
. . . . . identifier Σ 0..1 Identifier Identifier of related objects or events
. . . . . ref Σ 0..1 Reference(Any) Related Resource

doco Documentation for this format
Name Flags Card. Type Description & Constraints doco
. . DomainResource I Resource A resource with narrative, extensions, and contained resources
+ If the resource is contained in another resource, it SHALL NOT contain nested Resources
+ If the resource is contained in another resource, it SHALL NOT contain any narrative
+ If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
+ If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
Elements defined in Ancestors: id, meta, implicitRules, language
. . . text I 0..1 Narrative Text summary of the resource, for human interpretation
. . . contained 0..* Resource Contained, inline Resources
. . . extension 0..* Extension Additional Content defined by implementations
. . . modifierExtension ?! 0..* Extension Extensions that cannot be ignored

doco Documentation for this format
Name Flags Card. Type Description & Constraints doco
. . EligibilityRequest DomainResource Determine insurance validity and scope of coverage
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
. . . identifier 0..* Identifier Business Identifier
. . . status ?! Σ 0..1 code active | cancelled | draft | entered-in-error
Financial Resource Status Codes (Required)
. . . priority 0..1 CodeableConcept Desired processing priority
Process Priority Codes (Example)
. . . patient 0..1 Reference(Patient) The subject of the Products and Services
. . . serviced[x] 0..1 Estimated date or dates of Service
. . . . servicedDate date
. . . . servicedPeriod Period
. . . created 0..1 dateTime Creation date
. . . enterer 0..1 Reference(Practitioner) Author
. . . provider 0..1 Reference(Practitioner) Responsible practitioner
. . . organization 0..1 Reference(Organization) Responsible organization
. . . insurer 0..1 Reference(Organization) Target
. . . facility 0..1 Reference(Location) Servicing Facility
. . . coverage 0..1 Reference(Coverage) Insurance or medical plan
. . . businessArrangement 0..1 string Business agreement
. . . benefitCategory 0..1 CodeableConcept Type of services covered
Benefit Category Codes (Example)
. . . benefitSubCategory 0..1 CodeableConcept Detailed services covered within the type
Benefit SubCategory Codes (Example)

doco Documentation for this format
Name Flags Card. Type Description & Constraints doco
. . EligibilityResponse DomainResource EligibilityResponse resource
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
. . . identifier 0..* Identifier Business Identifier
. . . status ?! Σ 0..1 code active | cancelled | draft | entered-in-error
Financial Resource Status Codes (Required)
. . . created 0..1 dateTime Creation date
. . . requestProvider 0..1 Reference(Practitioner) Responsible practitioner
. . . requestOrganization 0..1 Reference(Organization) Responsible organization
. . . request 0..1 Reference(EligibilityRequest) Eligibility reference
. . . outcome 0..1 CodeableConcept complete | error | partial
RemittanceOutcome (Required)
. . . disposition 0..1 string Disposition Message
. . . insurer 0..1 Reference(Organization) Insurer issuing the coverage
. . . inforce 0..1 boolean Coverage inforce indicator
. . . insurance 0..* BackboneElement Details by insurance coverage
. . . . coverage 0..1 Reference(Coverage) Updated Coverage details
. . . . contract 0..1 Reference(Contract) Contract details
. . . . benefitBalance 0..* BackboneElement Benefits by Category
. . . . . category 1..1 CodeableConcept Type of services covered
Benefit Category Codes (Example)
. . . . . subCategory 0..1 CodeableConcept Detailed services covered within the type
Benefit SubCategory Codes (Example)
. . . . . excluded 0..1 boolean Excluded from the plan
. . . . . name 0..1 string Short name for the benefit
. . . . . description 0..1 string Description of the benefit or services covered
. . . . . network 0..1 CodeableConcept In or out of network
Network Type Codes (Example)
. . . . . unit 0..1 CodeableConcept Individual or family
Unit Type Codes (Example)
. . . . . term 0..1 CodeableConcept Annual or lifetime
Benefit Term Codes (Example)
. . . . . financial 0..* BackboneElement Benefit Summary
. . . . . . type 1..1 CodeableConcept Deductable, visits, benefit amount
Benefit Type Codes (Example)
. . . . . . allowed[x] 0..1 Benefits allowed
. . . . . . . allowedUnsignedInt unsignedInt
. . . . . . . allowedString string
. . . . . . . allowedMoney Money
. . . . . . used[x] 0..1 Benefits used
. . . . . . . usedUnsignedInt unsignedInt
. . . . . . . usedMoney Money
. . . form 0..1 CodeableConcept Printed Form Identifier
Form Codes (Example)
. . . error 0..* BackboneElement Processing errors
. . . . code 1..1 CodeableConcept Error code detailing processing issues
Adjudication Error Codes (Example)

doco Documentation for this format
Name Flags Card. Type Description & Constraints doco
. . Encounter DomainResource An interaction during which services are provided to the patient
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
. . . identifier Σ 0..* Identifier Identifier(s) by which this encounter is known
. . . status ?! Σ 1..1 code planned | arrived | triaged | in-progress | onleave | finished | cancelled +
EncounterStatus (Required)
. . . statusHistory 0..* BackboneElement List of past encounter statuses
. . . . status 1..1 code planned | arrived | triaged | in-progress | onleave | finished | cancelled +
EncounterStatus (Required)
. . . . period 1..1 Period The time that the episode was in the specified status
. . . class Σ 0..1 Coding inpatient | outpatient | ambulatory | emergency +
ActEncounterCode (Extensible)
. . . classHistory 0..* BackboneElement List of past encounter classes
. . . . class 1..1 Coding inpatient | outpatient | ambulatory | emergency +
ActEncounterCode (Extensible)
. . . . period 1..1 Period The time that the episode was in the specified class
. . . type Σ 0..* CodeableConcept Specific type of encounter
EncounterType (Example)
. . . priority 0..1 CodeableConcept Indicates the urgency of the encounter
v3 Code System ActPriority (Example)
. . . subject Σ 0..1 Reference(Patient | Group) The patient ro group present at the encounter
. . . episodeOfCare Σ 0..* Reference(EpisodeOfCare) Episode(s) of care that this encounter should be recorded against
. . . incomingReferral 0..* Reference(ReferralRequest) The ReferralRequest that initiated this encounter
. . . participant Σ 0..* BackboneElement List of participants involved in the encounter
. . . . type Σ 0..* CodeableConcept Role of participant in encounter
ParticipantType (Extensible)
. . . . period 0..1 Period Period of time during the encounter that the participant participated
. . . . individual Σ 0..1 Reference(Practitioner | RelatedPerson) Persons involved in the encounter other than the patient
. . . appointment Σ 0..1 Reference(Appointment) The appointment that scheduled this encounter
. . . period 0..1 Period The start and end time of the encounter
. . . length 0..1 Duration Quantity of time the encounter lasted (less time absent)
. . . reason Σ 0..* CodeableConcept Reason the encounter takes place (code)
Encounter Reason Codes (Preferred)
. . . diagnosis Σ 0..* BackboneElement The list of diagnosis relevant to this encounter
. . . . condition 1..1 Reference(Condition | Procedure) Reason the encounter takes place (resource)
. . . . role 0..1 CodeableConcept Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …)
DiagnosisRole (Preferred)
. . . . rank 0..1 positiveInt Ranking of the diagnosis (for each role type)
. . . account 0..* Reference(Account) The set of accounts that may be used for billing for this Encounter
. . . hospitalization 0..1 BackboneElement Details about the admission to a healthcare service
. . . . preAdmissionIdentifier 0..1 Identifier Pre-admission identifier
. . . . origin 0..1 Reference(Location) The location from which the patient came before admission
. . . . admitSource 0..1 CodeableConcept From where patient was admitted (physician referral, transfer)
AdmitSource (Preferred)
. . . . reAdmission 0..1 CodeableConcept The type of hospital re-admission that has occurred (if any). If the value is absent, then this is not identified as a readmission
v2 Re-Admission Indicator (Example)
. . . . dietPreference 0..* CodeableConcept Diet preferences reported by the patient
Diet (Example)
. . . . specialCourtesy 0..* CodeableConcept Special courtesies (VIP, board member)
SpecialCourtesy (Preferred)
. . . . specialArrangement 0..* CodeableConcept Wheelchair, translator, stretcher, etc.
SpecialArrangements (Preferred)
. . . . destination 0..1 Reference(Location) Location to which the patient is discharged
. . . . dischargeDisposition 0..1 CodeableConcept Category or kind of location after discharge
DischargeDisposition (Example)
. . . location 0..* BackboneElement List of locations where the patient has been
. . . . location 1..1 Reference(Location) Location the encounter takes place
. . . . status 0..1 code planned | active | reserved | completed
EncounterLocationStatus (Required)
. . . . period 0..1 Period Time period during which the patient was present at the location
. . . serviceProvider 0..1 Reference(Organization) The custodian organization of this Encounter record
. . . partOf 0..1 Reference(Encounter) Another Encounter this encounter is part of

doco Documentation for this format
Name Flags Card. Type Description & Constraints doco
. . Endpoint DomainResource The technical details of an endpoint that can be used for electronic services
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
. . . identifier Σ 0..* Identifier Identifies this endpoint across multiple systems
. . . status ?! Σ 1..1 code active | suspended | error | off | entered-in-error | test
EndpointStatus (Required)
. . . connectionType Σ 1..1 Coding Protocol/Profile/Standard to be used with this endpoint connection
Endpoint Connection Type (Extensible)
. . . name Σ 0..1 string A name that this endpoint can be identified by
. . . managingOrganization Σ 0..1 Reference(Organization) Organization that manages this endpoint (may not be the organization that exposes the endpoint)
. . . contact 0..* ContactPoint Contact details for source (e.g. troubleshooting)
. . . period Σ 0..1 Period Interval the endpoint is expected to be operational
. . . payloadType Σ 1..* CodeableConcept The type of content that may be used at this endpoint (e.g. XDS Discharge summaries)
Endpoint Payload Type (Example)
. . . payloadMimeType Σ 0..* code Mimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this)
MimeType (Required)
. . . address Σ 1..1 uri The technical base address for connecting to this endpoint
. . . header 0..* string Usage depends on the channel type

doco Documentation for this format
Name Flags Card. Type Description & Constraints doco
. . EnrollmentRequest DomainResource Enrollment request
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
. . . identifier 0..* Identifier Business Identifier
. . . status ?! Σ 0..1 code active | cancelled | draft | entered-in-error
Financial Resource Status Codes (Required)
. . . created 0..1 dateTime Creation date
. . . insurer 0..1 Reference(Organization) Target
. . . provider 0..1 Reference(Practitioner) Responsible practitioner
. . . organization 0..1 Reference(Organization) Responsible organization
. . . subject 0..1 Reference(Patient) The subject of the Products and Services
. . . coverage 0..1 Reference(Coverage) Insurance information

doco Documentation for this format
Name Flags Card. Type Description & Constraints doco
. . EnrollmentResponse DomainResource EnrollmentResponse resource
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
. . . identifier 0..* Identifier Business Identifier
. . . status ?! Σ 0..1 code active | cancelled | draft | entered-in-error
Financial Resource Status Codes (Required)
. . . request 0..1 Reference(EnrollmentRequest) Claim reference
. . . outcome 0..1 CodeableConcept complete | error | partial
RemittanceOutcome (Required)
. . . disposition 0..1 string Disposition Message
. . . created 0..1 dateTime Creation date
. . . organization 0..1 Reference(Organization) Insurer
. . . requestProvider 0..1 Reference(Practitioner) Responsible practitioner
. . . requestOrganization 0..1 Reference(Organization) Responsible organization

doco Documentation for this format
Name Flags Card. Type Description & Constraints doco
. . EpisodeOfCare DomainResource An association of a Patient with an Organization and Healthcare Provider(s) for a period of time that the Organization assumes some level of responsibility
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
. . . identifier 0..* Identifier Business Identifier(s) relevant for this EpisodeOfCare
. . . status ?! Σ 1..1 code planned | waitlist | active | onhold | finished | cancelled | entered-in-error
EpisodeOfCareStatus (Required)
. . . statusHistory 0..* BackboneElement Past list of status codes (the current status may be included to cover the start date of the status)
. . . . status 1..1 code planned | waitlist | active | onhold | finished | cancelled | entered-in-error
EpisodeOfCareStatus (Required)
. . . . period 1..1 Period Duration the EpisodeOfCare was in the specified status
. . . type Σ 0..* CodeableConcept Type/class - e.g. specialist referral, disease management
EpisodeOfCareType (Example)
. . . diagnosis Σ 0..* BackboneElement The list of diagnosis relevant to this episode of care
. . . . condition Σ 1..1 Reference(Condition) Conditions/problems/diagnoses this episode of care is for
. . . . role Σ 0..1 CodeableConcept Role that this diagnosis has within the episode of care (e.g. admission, billing, discharge …)
DiagnosisRole (Preferred)
. . . . rank Σ 0..1 positiveInt Ranking of the diagnosis (for each role type)
. . . patient Σ 1..1 Reference(Patient) The patient who is the focus of this episode of care
. . . managingOrganization Σ 0..1 Reference(Organization) Organization that assumes care
. . . period Σ 0..1 Period Interval during responsibility is assumed
. . . referralRequest 0..* Reference(ReferralRequest) Originating Referral Request(s)
. . . careManager 0..1 Reference(Practitioner) Care manager/care co-ordinator for the patient
. . . team 0..* Reference(CareTeam) Other practitioners facilitating this episode of care
. . . account 0..* Reference(Account) The set of accounts that may be used for billing for this EpisodeOfCare

doco Documentation for this format
Name Flags Card. Type Description & Constraints doco
. . ExpansionProfile DomainResource Defines behaviour and contraints on the ValueSet Expansion operation
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
. . . url Σ 0..1 uri Logical URI to reference this expansion profile (globally unique)
. . . identifier Σ 0..1 Identifier Additional identifier for the expansion profile
. . . version Σ 0..1 string Business version of the expansion profile
. . . name Σ 0..1 string Name for this expansion profile (computer friendly)
. . . status ?! Σ 1..1 code draft | active | retired | unknown
PublicationStatus (Required)
. . . experimental ?! Σ 0..1 boolean For testing purposes, not real usage
. . . date Σ 0..1 dateTime Date this was last changed
. . . publisher Σ 0..1 string Name of the publisher (organization or individual)
. . . contact Σ 0..* ContactDetail Contact details for the publisher
. . . description 0..1 markdown Natural language description of the expansion profile
. . . useContext Σ 0..* UsageContext Context the content is intended to support
. . . jurisdiction Σ 0..* CodeableConcept Intended jurisdiction for expansion profile (if applicable)
Jurisdiction ValueSet (Extensible)
. . . fixedVersion Σ 0..* BackboneElement Fix use of a code system to a particular version
. . . . system Σ 1..1 uri System to have its version fixed
. . . . version Σ 1..1 string Specific version of the code system referred to
. . . . mode Σ 1..1 code default | check | override
SystemVersionProcessingMode (Required)
. . . excludedSystem Σ 0..1 BackboneElement Systems/Versions to be exclude
. . . . system Σ 1..1 uri The specific code system to be excluded
. . . . version Σ 0..1 string Specific version of the code system referred to
. . . includeDesignations Σ 0..1 boolean Whether the expansion should include concept designations
. . . designation Σ 0..1 BackboneElement When the expansion profile imposes designation contraints
. . . . include Σ 0..1 BackboneElement Designations to be included
. . . . . designation Σ I 0..* BackboneElement The designation to be included
+ SHALL have at least one of language or use
. . . . . . language Σ 0..1 code Human language of the designation to be included
Common Languages (Extensible but limited to All Languages)
. . . . . . use Σ 0..1 Coding What kind of Designation to include
Designation Use (Required)
. . . . exclude Σ 0..1 BackboneElement Designations to be excluded
. . . . . designation Σ I 0..* BackboneElement The designation to be excluded
+ SHALL have at least one of language or use
. . . . . . language Σ 0..1 code Human language of the designation to be excluded
Common Languages (Extensible but limited to All Languages)
. . . . . . use Σ 0..1 Coding What kind of Designation to exclude
Designation Use (Required)
. . . includeDefinition Σ 0..1 boolean Include or exclude the value set definition in the expansion
. . . activeOnly Σ 0..1 boolean Include or exclude inactive concepts in the expansion
. . . excludeNested Σ 0..1 boolean Nested codes in the expansion or not
. . . excludeNotForUI Σ 0..1 boolean Include or exclude codes which cannot be rendered in user interfaces in the value set expansion
. . . excludePostCoordinated Σ 0..1 boolean Include or exclude codes which are post coordinated expressions in the value set expansion
. . . displayLanguage Σ 0..1 code Specify the language for the display element of codes in the value set expansion
Common Languages (Extensible but limited to All Languages)
. . . limitedExpansion Σ 0..1 boolean Controls behaviour of the value set expand operation when value sets are too large to be completely expanded

doco Documentation for this format
Name Flags Card. Type Description & Constraints doco
. . ExplanationOfBenefit DomainResource Explanation of Benefit resource
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
. . . identifier 0..* Identifier Business Identifier
. . . status ?! Σ 0..1 code active | cancelled | draft | entered-in-error
ExplanationOfBenefitStatus (Required)
. . . type 0..1 CodeableConcept Type or discipline
Example Claim Type Codes (Required)
. . . subType 0..* CodeableConcept Finer grained claim type information
Example Claim SubType Codes (Example)
. . . patient 0..1 Reference(Patient) The subject of the Products and Services
. . . billablePeriod 0..1 Period Period for charge submission
. . . created 0..1 dateTime Creation date
. . . enterer 0..1 Reference(Practitioner) Author
. . . insurer 0..1 Reference(Organization) Insurer responsible for the EOB
. . . provider 0..1 Reference(Practitioner) Responsible provider for the claim
. . . organization 0..1 Reference(Organization) Responsible organization for the claim
. . . referral 0..1 Reference(ReferralRequest) Treatment Referral
. . . facility 0..1 Reference(Location) Servicing Facility
. . . claim 0..1 Reference(Claim) Claim reference
. . . claimResponse 0..1 Reference(ClaimResponse) Claim response reference
. . . outcome 0..1 CodeableConcept complete | error | partial
Claim Processing Codes (Example)
. . . disposition 0..1 string Disposition Message
. . . related 0..* BackboneElement Related Claims which may be revelant to processing this claim
. . . . claim 0..1 Reference(Claim) Reference to the related claim
. . . . relationship 0..1 CodeableConcept How the reference claim is related
Example Related Claim Relationship Codes (Example)
. . . . reference 0..1 Identifier Related file or case reference
. . . prescription 0..1 Reference(MedicationRequest | VisionPrescription) Prescription authorizing services or products
. . . originalPrescription 0..1 Reference(MedicationRequest) Original prescription if superceded by fulfiller
. . . payee 0..1 BackboneElement Party to be paid any benefits payable
. . . . type 0..1 CodeableConcept Type of party: Subscriber, Provider, other
Claim Payee Type Codes (Example)
. . . . resourceType 0..1 CodeableConcept organization | patient | practitioner | relatedperson
PayeeResourceType (Required)
. . . . party 0..1 Reference(Practitioner | Organization | Patient | RelatedPerson) Party to receive the payable
. . . information 0..* BackboneElement Exceptions, special considerations, the condition, situation, prior or concurrent issues
. . . . sequence 1..1 positiveInt Information instance identifier
. . . . category 1..1 CodeableConcept General class of information
Claim Information Category Codes (Example)
. . . . code 0..1 CodeableConcept Type of information
Exception Codes (Example)
. . . . timing[x] 0..1 When it occurred
. . . . . timingDate date
. . . . . timingPeriod Period
. . . . value[x] 0..1 Additional Data or supporting information
. . . . . valueString string
. . . . . valueQuantity Quantity
. . . . . valueAttachment Attachment
. . . . . valueReference Reference(Any)
. . . . reason 0..1 Coding Reason associated with the information
Missing Tooth Reason Codes (Example)
. . . careTeam 0..* BackboneElement Care Team members
. . . . sequence 1..1 positiveInt Number to covey order of careteam
. . . . provider 1..1 Reference(Practitioner | Organization) Member of the Care Team
. . . . responsible 0..1 boolean Billing practitioner
. . . . role 0..1 CodeableConcept Role on the team
Claim Care Team Role Codes (Example)
. . . . qualification 0..1 CodeableConcept Type, classification or Specialization
Example Provider Qualification Codes (Example)
. . . diagnosis 0..* BackboneElement List of Diagnosis
. . . . sequence 1..1 positiveInt Number to covey order of diagnosis
. . . . diagnosis[x] 1..1 Patient's diagnosis
ICD-10 Codes (Example)
. . . . . diagnosisCodeableConcept CodeableConcept
. . . . . diagnosisReference Reference(Condition)
. . . . type 0..* CodeableConcept Timing or nature of the diagnosis
Example Diagnosis Type Codes (Example)
. . . . packageCode 0..1 CodeableConcept Package billing code
Example Diagnosis Related Group Codes (Example)
. . . procedure 0..* BackboneElement Procedures performed
. . . . sequence 1..1 positiveInt Procedure sequence for reference
. . . . date 0..1 dateTime When the procedure was performed
. . . . procedure[x] 1..1 Patient's list of procedures performed
ICD-10 Procedure Codes (Example)
. . . . . procedureCodeableConcept CodeableConcept
. . . . . procedureReference Reference(Procedure)
. . . precedence 0..1 positiveInt Precedence (primary, secondary, etc.)
. . . insurance 0..1 BackboneElement Insurance or medical plan
. . . . coverage 0..1 Reference(Coverage) Insurance information
. . . . preAuthRef 0..* string Pre-Authorization/Determination Reference
. . . accident 0..1 BackboneElement Details of an accident
. . . . date 0..1 date When the accident occurred
. . . . type 0..1 CodeableConcept The nature of the accident
ActIncidentCode (Required)
. . . . location[x] 0..1 Accident Place
. . . . . locationAddress Address
. . . . . locationReference Reference(Location)
. . . employmentImpacted 0..1 Period Period unable to work
. . . hospitalization 0..1 Period Period in hospital
. . . item 0..* BackboneElement Goods and Services
. . . . sequence 1..1 positiveInt Service instance
. . . . careTeamLinkId 0..* positiveInt Applicable careteam members
. . . . diagnosisLinkId 0..* positiveInt Applicable diagnoses
. . . . procedureLinkId 0..* positiveInt Applicable procedures
. . . . informationLinkId 0..* positiveInt Applicable exception and supporting information
. . . . revenue 0..1 CodeableConcept Revenue or cost center code
Example Revenue Center Codes (Example)
. . . . category 0..1 CodeableConcept Type of service or product
Benefit SubCategory Codes (Example)
. . . . service 0..1 CodeableConcept Billing Code
USCLS Codes (Example)
. . . . modifier 0..* CodeableConcept Service/Product billing modifiers
Modifier type Codes (Example)
. . . . programCode 0..* CodeableConcept Program specific reason for item inclusion
Example Program Reason Codes (Example)
. . . . serviced[x] 0..1 Date or dates of Service
. . . . . servicedDate date
. . . . . servicedPeriod Period
. . . . location[x] 0..1 Place of service
Example Service Place Codes (Example)
. . . . . locationCodeableConcept CodeableConcept
. . . . . locationAddress Address
. . . . . locationReference Reference(Location)
. . . . quantity 0..1 SimpleQuantity Count of Products or Services
. . . . unitPrice 0..1 Money Fee, charge or cost per point
. . . . factor 0..1 decimal Price scaling factor
. . . . net 0..1 Money Total item cost
. . . . udi 0..* Reference(Device) Unique Device Identifier
. . . . bodySite 0..1 CodeableConcept Service Location
Oral Site Codes (Example)
. . . . subSite 0..* CodeableConcept Service Sub-location
Surface Codes (Example)
. . . . encounter 0..* Reference(Encounter) Encounters related to this billed item
. . . . noteNumber 0..* positiveInt List of note numbers which apply
. . . . adjudication 0..* BackboneElement Adjudication details
. . . . . category 1..1 CodeableConcept Adjudication category such as co-pay, eligible, benefit, etc.
Adjudication Value Codes (Example)
. . . . . reason 0..1 CodeableConcept Explanation of Adjudication outcome
Adjudication Reason Codes (Example)
. . . . . amount 0..1 Money Monetary amount
. . . . . value 0..1 decimal Non-monitory value
. . . . detail 0..* BackboneElement Additional items
. . . . . sequence 1..1 positiveInt Service instance
. . . . . type 1..1 CodeableConcept Group or type of product or service
ActInvoiceGroupCode (Required)
. . . . . revenue 0..1 CodeableConcept Revenue or cost center code
Example Revenue Center Codes (Example)
. . . . . category 0..1 CodeableConcept Type of service or product
Benefit SubCategory Codes (Example)
. . . . . service 0..1 CodeableConcept Billing Code
USCLS Codes (Example)
. . . . . modifier 0..* CodeableConcept Service/Product billing modifiers
Modifier type Codes (Example)
. . . . . programCode 0..* CodeableConcept Program specific reason for item inclusion
Example Program Reason Codes (Example)
. . . . . quantity 0..1 SimpleQuantity Count of Products or Services
. . . . . unitPrice 0..1 Money Fee, charge or cost per point
. . . . . factor 0..1 decimal Price scaling factor
. . . . . net 0..1 Money Total additional item cost
. . . . . udi 0..* Reference(Device) Unique Device Identifier
. . . . . noteNumber 0..* positiveInt List of note numbers which apply
. . . . . adjudication 0..* see adjudication Detail level adjudication details
. . . . . subDetail 0..* BackboneElement Additional items
. . . . . . sequence 1..1 positiveInt Service instance
. . . . . . type 1..1 CodeableConcept Type of product or service
ActInvoiceGroupCode (Required)
. . . . . . revenue 0..1 CodeableConcept Revenue or cost center code
Example Revenue Center Codes (Example)
. . . . . . category 0..1 CodeableConcept Type of service or product
Benefit SubCategory Codes (Example)
. . . . . . service 0..1 CodeableConcept Billing Code
USCLS Codes (Example)
. . . . . . modifier 0..* CodeableConcept Service/Product billing modifiers
Modifier type Codes (Example)
. . . . . . programCode 0..* CodeableConcept Program specific reason for item inclusion
Example Program Reason Codes (Example)
. . . . . . quantity 0..1 SimpleQuantity Count of Products or Services
. . . . . . unitPrice 0..1 Money Fee, charge or cost per point
. . . . . . factor 0..1 decimal Price scaling factor
. . . . . . net 0..1 Money Net additional item cost
. . . . . . udi 0..* Reference(Device) Unique Device Identifier
. . . . . . noteNumber 0..* positiveInt List of note numbers which apply
. . . . . . adjudication 0..* see adjudication Language if different from the resource
. . . addItem 0..* BackboneElement Insurer added line items
. . . . sequenceLinkId 0..* positiveInt Service instances
. . . . revenue 0..1 CodeableConcept Revenue or cost center code
Example Revenue Center Codes (Example)
. . . . category 0..1 CodeableConcept Type of service or product
Benefit SubCategory Codes (Example)
. . . . service 0..1 CodeableConcept Billing Code
USCLS Codes (Example)
. . . . modifier 0..* CodeableConcept Service/Product billing modifiers
Modifier type Codes (Example)
. . . . fee 0..1 Money Professional fee or Product charge
. . . . noteNumber 0..* positiveInt List of note numbers which apply
. . . . adjudication 0..* see adjudication Added items adjudication
. . . . detail 0..* BackboneElement Added items details
. . . . . revenue 0..1 CodeableConcept Revenue or cost center code
Example Revenue Center Codes (Example)
. . . . . category 0..1 CodeableConcept Type of service or product
Benefit SubCategory Codes (Example)
. . . . . service 0..1 CodeableConcept Billing Code
USCLS Codes (Example)
. . . . . modifier 0..* CodeableConcept Service/Product billing modifiers
Modifier type Codes (Example)
. . . . . fee 0..1 Money Professional fee or Product charge
. . . . . noteNumber 0..* positiveInt List of note numbers which apply
. . . . . adjudication 0..* see adjudication Added items detail adjudication
. . . totalCost 0..1 Money Total Cost of service from the Claim
. . . unallocDeductable 0..1 Money Unallocated deductable
. . . totalBenefit 0..1 Money Total benefit payable for the Claim
. . . payment 0..1 BackboneElement Payment (if paid)
. . . . type 0..1 CodeableConcept Partial or Complete
Example Payment Type Codes (Example)
. . . . adjustment 0..1 Money Payment adjustment for non-Claim issues
. . . . adjustmentReason 0..1 CodeableConcept Explanation for the non-claim adjustment
Payment Adjustment Reason Codes (Example)
. . . . date 0..1 date Expected date of Payment
. . . . amount 0..1 Money Payable amount after adjustment
. . . . identifier 0..1 Identifier Identifier of the payment instrument
. . . form 0..1 CodeableConcept Printed Form Identifier
Form Codes (Example)
. . . processNote 0..* BackboneElement Processing notes
. . . . number 0..1 positiveInt Sequence number for this note
. . . . type 0..1 CodeableConcept display | print | printoper
NoteType (Required)
. . . . text 0..1 string Note explanitory text
. . . . language 0..1 CodeableConcept Language if different from the resource
Common Languages (Extensible but limited to All Languages)
. . . benefitBalance 0..* BackboneElement Balance by Benefit Category
. . . . category 1..1 CodeableConcept Type of services covered
Benefit Category Codes (Example)
. . . . subCategory 0..1 CodeableConcept Detailed services covered within the type
Benefit SubCategory Codes (Example)
. . . . excluded 0..1 boolean Excluded from the plan
. . . . name 0..1 string Short name for the benefit
. . . . description 0..1 string Description of the benefit or services covered
. . . . network 0..1 CodeableConcept In or out of network
Network Type Codes (Example)
. . . . unit 0..1 CodeableConcept Individual or family
Unit Type Codes (Example)
. . . . term 0..1 CodeableConcept Annual or lifetime
Benefit Term Codes (Example)
. . . . financial 0..* BackboneElement Benefit Summary
. . . . . type 1..1 CodeableConcept Deductable, visits, benefit amount
Benefit Type Codes (Example)
. . . . . allowed[x] 0..1 Benefits allowed
. . . . . . allowedUnsignedInt unsignedInt
. . . . . . allowedString string
. . . . . . allowedMoney Money
. . . . . used[x] 0..1 Benefits used
. . . . . . usedUnsignedInt unsignedInt
. . . . . . usedMoney Money

doco Documentation for this format
Name Flags Card. Type Description & Constraints doco
. . FamilyMemberHistory I DomainResource Information about patient's relatives, relevant for patient
+ Can only have estimatedAge if age[x] is present
+ Not Done Reason can only be specified if NotDone is "true"
+ Can have age[x] or born[x], but not both
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
. . . identifier Σ 0..* Identifier External Id(s) for this record
. . . definition Σ 0..* Reference(PlanDefinition | Questionnaire) Instantiates protocol or definition
. . . status ?! Σ 1..1 code partial | completed | entered-in-error | health-unknown
FamilyHistoryStatus (Required)
. . . notDone ?! Σ 0..1 boolean The taking of a family member's history did not occur
. . . notDoneReason Σ I 0..1 CodeableConcept subject-unknown | withheld | unable-to-obtain | deferred
FamilyHistoryNotDoneReason (Example)
. . . patient Σ 1..1 Reference(Patient) Patient history is about
. . . date Σ 0..1 dateTime When history was captured/updated
. . . name Σ 0..1 string The family member described
. . . relationship Σ 1..1 CodeableConcept Relationship to the subject
FamilyMember (Example)
. . . gender Σ 0..1 code male | female | other | unknown
AdministrativeGender (Required)
. . . born[x] I 0..1 (approximate) date of birth
. . . . bornPeriod Period
. . . . bornDate date
. . . . bornString string
. . . age[x] Σ I 0..1 (approximate) age
. . . . ageAge Age
. . . . ageRange Range
. . . . ageString string
. . . estimatedAge ?! Σ I 0..1 boolean Age is estimated?
. . . deceased[x] Σ 0..1 Dead? How old/when?
. . . . deceasedBoolean boolean
. . . . deceasedAge Age
. . . . deceasedRange Range
. . . . deceasedDate date
. . . . deceasedString string
. . . reasonCode Σ 0..* CodeableConcept Why was family member history performed?
SNOMED CT Clinical Findings (Example)
. . . reasonReference Σ 0..* Reference(Condition | Observation | AllergyIntolerance | QuestionnaireResponse) Why was family member history performed?
. . . note 0..* Annotation General note about related person
. . . condition 0..* BackboneElement Condition that the related person had
. . . . code 1..1 CodeableConcept Condition suffered by relation
Condition/Problem/Diagnosis Codes (Example)
. . . . outcome 0..1 CodeableConcept deceased | permanent disability | etc.
Condition Outcome Codes (Example)
. . . . onset[x] 0..1 When condition first manifested
. . . . . onsetAge Age
. . . . . onsetRange Range
. . . . . onsetPeriod Period
. . . . . onsetString string
. . . . note 0..* Annotation Extra information about condition

doco Documentation for this format
Name Flags Card. Type Description & Constraints doco
. . Flag DomainResource Key information to flag to healthcare providers
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
. . . identifier Σ 0..* Identifier Business identifier
. . . status ?! Σ 1..1 code active | inactive | entered-in-error
FlagStatus (Required)
. . . category Σ 0..1 CodeableConcept Clinical, administrative, etc.
Flag Category (Example)
. . . code Σ 1..1 CodeableConcept Coded or textual message to display to user
Flag Code (Example)
. . . subject Σ 1..1 Reference(Patient | Location | Group | Organization | Practitioner | PlanDefinition | Medication | Procedure) Who/What is flag about?
. . . period Σ 0..1 Period Time period when flag is active
. . . encounter Σ 0..1 Reference(Encounter) Alert relevant during encounter
. . . author Σ 0..1 Reference(Device | Organization | Patient | Practitioner) Flag creator

doco Documentation for this format
Name Flags Card. Type Description & Constraints doco
. . Goal DomainResource Describes the intended objective(s) for a patient, group or organization
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
. . . identifier 0..* Identifier External Ids for this goal
. . . status ?! Σ 1..1 code proposed | accepted | planned | in-progress | on-target | ahead-of-target | behind-target | sustaining | achieved | on-hold | cancelled | entered-in-error | rejected
GoalStatus (Required)
. . . category Σ 0..* CodeableConcept E.g. Treatment, dietary, behavioral, etc.
GoalCategory (Example)
. . . priority Σ 0..1 CodeableConcept high-priority | medium-priority | low-priority
GoalPriority (Preferred)
. . . description Σ 1..1 CodeableConcept Code or text describing goal
SNOMED CT Clinical Findings (Example)
. . . subject Σ 0..1 Reference(Patient | Group | Organization) Who this goal is intended for
. . . start[x] Σ 0..1 When goal pursuit begins
GoalStartEvent (Example)
. . . . startDate date
. . . . startCodeableConcept CodeableConcept
. . . target I 0..1 BackboneElement Target outcome for the goal
+ Goal.target.measure is required if Goal.target.detail is populated
. . . . measure Σ I 0..1 CodeableConcept The parameter whose value is being tracked
LOINC Codes (Example)
. . . . detail[x] Σ I 0..1 The target value to be achieved
. . . . . detailQuantity Quantity
. . . . . detailRange Range
. . . . . detailCodeableConcept CodeableConcept
. . . . due[x] Σ 0..1 Reach goal on or before
. . . . . dueDate date
. . . . . dueDuration Duration
. . . statusDate Σ 0..1 date When goal status took effect
. . . statusReason 0..1 string Reason for current status
. . . expressedBy Σ 0..1 Reference(Patient | Practitioner | RelatedPerson) Who's responsible for creating Goal?
. . . addresses 0..* Reference(Condition | Observation | MedicationStatement | NutritionOrder | ProcedureRequest | RiskAssessment) Issues addressed by this goal
. . . note 0..* Annotation Comments about the goal
. . . outcomeCode 0..* CodeableConcept What result was achieved regarding the goal?
SNOMED CT Clinical Findings (Example)
. . . outcomeReference 0..* Reference(Observation) Observation that resulted from goal

doco Documentation for this format
Name Flags Card. Type Description & Constraints doco
. . GraphDefinition DomainResource Definition of an graph of resources
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
. . . url Σ 0..1 uri Logical URI to reference this graph definition (globally unique)
. . . version Σ 0..1 string Business version of the graph definition
. . . name Σ 1..1 string Name for this graph definition (computer friendly)
. . . status ?! Σ 1..1 code draft | active | retired | unknown
PublicationStatus (Required)
. . . experimental ?! Σ 0..1 boolean For testing purposes, not real usage
. . . date Σ 0..1 dateTime Date this was last changed
. . . publisher Σ 0..1 string Name of the publisher (organization or individual)
. . . contact Σ 0..* ContactDetail Contact details for the publisher
. . . description 0..1 markdown Natural language description of the graph definition
. . . useContext Σ 0..* UsageContext Context the content is intended to support
. . . jurisdiction Σ 0..* CodeableConcept Intended jurisdiction for graph definition (if applicable)
Jurisdiction ValueSet (Extensible)
. . . purpose 0..1 markdown Why this graph definition is defined
. . . start 1..1 code Type of resource at which the graph starts
ResourceType (Required)
. . . profile 0..1 uri Profile on base resource
. . . link 0..* BackboneElement Links this graph makes rules about
. . . . path 1..1 string Path in the resource that contains the link
. . . . sliceName 0..1 string Which slice (if profiled)
. . . . min 0..1 integer Minimum occurrences for this link
. . . . max 0..1 string Maximum occurrences for this link
. . . . description 0..1 string Why this link is specified
. . . . target 1..* BackboneElement Potential target for the link
. . . . . type 1..1 code Type of resource this link refers to
ResourceType (Required)
. . . . . profile 0..1 uri Profile for the target resource
. . . . . compartment 0..* BackboneElement Compartment Consistency Rules
. . . . . . code 1..1 code Identifies the compartment
CompartmentType (Required)
. . . . . . rule 1..1 code identical | matching | different | custom
GraphCompartmentRule (Required)
. . . . . . expression 0..1 string Custom rule, as a FHIRPath expression
. . . . . . description 0..1 string Documentation for FHIRPath expression
. . . . . link 0..* see link Additional links from target resource

doco Documentation for this format
Name Flags Card. Type Description & Constraints doco
. . Group I DomainResource Group of multiple entities
+ Can only have members if group is "actual"
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
. . . identifier Σ 0..* Identifier Unique id
. . . active Σ 0..1 boolean Whether this group's record is in active use
. . . type Σ 1..1 code person | animal | practitioner | device | medication | substance
GroupType (Required)
. . . actual Σ I 1..1 boolean Descriptive or actual
. . . code Σ 0..1 CodeableConcept Kind of Group members
. . . name Σ 0..1 string Label for Group
. . . quantity Σ 0..1 unsignedInt Number of members
. . . characteristic 0..* BackboneElement Trait of group members
. . . . code 1..1 CodeableConcept Kind of characteristic
. . . . value[x] 1..1 Value held by characteristic
. . . . . valueCodeableConcept CodeableConcept
. . . . . valueBoolean boolean
. . . . . valueQuantity Quantity
. . . . . valueRange Range
. . . . exclude ?! 1..1 boolean Group includes or excludes
. . . . period 0..1 Period Period over which characteristic is tested
. . . member I 0..* BackboneElement Who or what is in group
. . . . entity 1..1 Reference(Patient | Practitioner | Device | Medication | Substance) Reference to the group member
. . . . period 0..1 Period Period member belonged to the group
. . . . inactive 0..1 boolean If member is no longer in group

doco Documentation for this format
Name Flags Card. Type Description & Constraints doco
. . GuidanceResponse DomainResource The formal response to a guidance request
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
. . . requestId Σ 0..1 id The id of the request associated with this response, if any
. . . identifier Σ 0..1 Identifier Business identifier
. . . module Σ 1..1 Reference(ServiceDefinition) A reference to a knowledge module
. . . status ?! Σ 1..1 code success | data-requested | data-required | in-progress | failure | entered-in-error
GuidanceResponseStatus (Required)
. . . subject 0..1 Reference(Patient | Group) Patient the request was performed for
. . . context 0..1 Reference(Encounter | EpisodeOfCare) Encounter or Episode during which the response was returned
. . . occurrenceDateTime 0..1 dateTime When the guidance response was processed
. . . performer 0..1 Reference(Device) Device returning the guidance
. . . reason[x] 0..1 Reason for the response
. . . . reasonCodeableConcept CodeableConcept
. . . . reasonReference Reference(Any)
. . . note 0..* Annotation Additional notes about the response
. . . evaluationMessage 0..* Reference(OperationOutcome) Messages resulting from the evaluation of the artifact or artifacts
. . . outputParameters 0..1 Reference(Parameters) The output parameters of the evaluation, if any
. . . result 0..1 Reference(CarePlan | RequestGroup) Proposed actions, if any
. . . dataRequirement 0..* DataRequirement Additional required data

doco Documentation for this format
Name Flags Card. Type Description & Constraints doco
. . HealthcareService DomainResource The details of a healthcare service available at a location
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
. . . identifier Σ 0..* Identifier External identifiers for this item
. . . active ?! Σ 0..1 boolean Whether this healthcareservice is in active use
. . . providedBy Σ 0..1 Reference(Organization) Organization that provides this service
. . . category Σ 0..1 CodeableConcept Broad category of service being performed or delivered
ServiceCategory (Example)
. . . type Σ 0..* CodeableConcept Type of service that may be delivered or performed
ServiceType (Example)
. . . specialty Σ 0..* CodeableConcept Specialties handled by the HealthcareService
Practice Setting Code Value Set (Preferred)
. . . location Σ 0..* Reference(Location) Location(s) where service may be provided
. . . name Σ 0..1 string Description of service as presented to a consumer while searching
. . . comment Σ 0..1 string Additional description and/or any specific issues not covered elsewhere
. . . extraDetails 0..1 string Extra details about the service that can't be placed in the other fields
. . . photo Σ 0..1 Attachment Facilitates quick identification of the service
. . . telecom 0..* ContactPoint Contacts related to the healthcare service
. . . coverageArea 0..* Reference(Location) Location(s) service is inteded for/available to
. . . serviceProvisionCode 0..* CodeableConcept Conditions under which service is available/offered
ServiceProvisionConditions (Example)
. . . eligibility 0..1 CodeableConcept Specific eligibility requirements required to use the service
. . . eligibilityNote 0..1 string Describes the eligibility conditions for the service
. . . programName 0..* string Program Names that categorize the service
. . . characteristic 0..* CodeableConcept Collection of characteristics (attributes)
. . . referralMethod 0..* CodeableConcept Ways that the service accepts referrals
ReferralMethod (Example)
. . . appointmentRequired 0..1 boolean If an appointment is required for access to this service
. . . availableTime 0..* BackboneElement Times the Service Site is available
. . . . daysOfWeek 0..* code mon | tue | wed | thu | fri | sat | sun
DaysOfWeek (Required)
. . . . allDay 0..1 boolean Always available? e.g. 24 hour service
. . . . availableStartTime 0..1 time Opening time of day (ignored if allDay = true)
. . . . availableEndTime 0..1 time Closing time of day (ignored if allDay = true)
. . . notAvailable 0..* BackboneElement Not available during this time due to provided reason
. . . . description 1..1 string Reason presented to the user explaining why time not available
. . . . during 0..1 Period Service not availablefrom this date
. . . availabilityExceptions 0..1 string Description of availability exceptions
. . . endpoint 0..* Reference(Endpoint) Technical endpoints providing access to services operated for the location

doco Documentation for this format
Name Flags Card. Type Description & Constraints doco
. . ImagingManifest DomainResource Key Object Selection
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
. . . identifier Σ 0..1 Identifier SOP Instance UID
. . . patient Σ 1..1 Reference(Patient) Patient of the selected objects
. . . authoringTime Σ 0..1 dateTime Time when the selection of instances was made
. . . author Σ 0..1 Reference(Practitioner | Device | Organization | Patient | RelatedPerson) Author (human or machine)
. . . description Σ 0..1 string Description text
. . . study Σ 1..* BackboneElement Study identity of the selected instances
. . . . uid Σ 1..1 oid Study instance UID
. . . . imagingStudy Σ 0..1 Reference(ImagingStudy) Reference to ImagingStudy
. . . . endpoint Σ 0..* Reference(Endpoint) Study access service endpoint
. . . . series Σ 1..* BackboneElement Series identity of the selected instances
. . . . . uid Σ 1..1 oid Series instance UID
. . . . . endpoint Σ 0..* Reference(Endpoint) Series access endpoint
. . . . . instance Σ 1..* BackboneElement The selected instance
. . . . . . sopClass Σ 1..1 oid SOP class UID of instance
. . . . . . uid Σ 1..1 oid Selected instance UID

doco Documentation for this format
Name Flags Card. Type Description & Constraints doco
. . ImagingStudy DomainResource A set of images produced in single study (one or more series of references images)
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
. . . uid Σ 1..1 oid Formal DICOM identifier for the study
. . . accession Σ 0..1 Identifier Related workflow identifier ("Accession Number")
. . . identifier Σ 0..* Identifier Other identifiers for the study
. . . availability Σ 0..1 code ONLINE | OFFLINE | NEARLINE | UNAVAILABLE
InstanceAvailability (Required)
. . . modalityList Σ 0..* Coding All series modality if actual acquisition modalities
Acquisition Modality Codes (Extensible)
. . . patient Σ 1..1 Reference(Patient) Who the images are of
. . . context Σ 0..1 Reference(Encounter | EpisodeOfCare) Originating context
. . . started Σ 0..1 dateTime When the study was started
. . . basedOn Σ 0..* Reference(ReferralRequest | CarePlan | ProcedureRequest) Request fulfilled
. . . referrer Σ 0..1 Reference(Practitioner) Referring physician
. . . interpreter Σ 0..* Reference(Practitioner) Who interpreted images
. . . endpoint Σ 0..* Reference(Endpoint) Study access endpoint
. . . numberOfSeries Σ 0..1 unsignedInt Number of Study Related Series
. . . numberOfInstances Σ 0..1 unsignedInt Number of Study Related Instances
. . . procedureReference Σ 0..* Reference(Procedure) The performed Procedure reference
. . . procedureCode Σ 0..* CodeableConcept The performed procedure code
Procedure Codes (SNOMED CT) (Example)
. . . reason Σ 0..1 CodeableConcept Why the study was requested
Procedure Reason Codes (Example)
. . . description Σ 0..1 string Institution-generated description
. . . series Σ 0..* BackboneElement Each study has one or more series of instances
. . . . uid Σ 1..1 oid Formal DICOM identifier for this series
. . . . number Σ 0..1 unsignedInt Numeric identifier of this series
. . . . modality Σ 1..1 Coding The modality of the instances in the series
Acquisition Modality Codes (Extensible)
. . . . description Σ 0..1 string A short human readable summary of the series
. . . . numberOfInstances Σ 0..1 unsignedInt Number of Series Related Instances
. . . . availability Σ 0..1 code ONLINE | OFFLINE | NEARLINE | UNAVAILABLE
InstanceAvailability (Required)
. . . . endpoint Σ 0..* Reference(Endpoint) Series access endpoint
. . . . bodySite Σ 0..1 Coding Body part examined
SNOMED CT Body Structures (Example)
. . . . laterality Σ 0..1 Coding Body part laterality
Laterality (Example)
. . . . started Σ 0..1 dateTime When the series started
. . . . performer Σ 0..* Reference(Practitioner) Who performed the series
. . . . instance 0..* BackboneElement A single SOP instance from the series
. . . . . uid 1..1 oid Formal DICOM identifier for this instance
. . . . . number 0..1 unsignedInt The number of this instance in the series
. . . . . sopClass 1..1 oid DICOM class type
. . . . . title 0..1 string Description of instance

doco Documentation for this format
Name Flags Card. Type Description & Constraints doco
. . Immunization I DomainResource Immunization event information
+ If immunization was administered (notGiven=false) then explanation.reasonNotGiven SHALL be absent.
+ If immunization was not administered (notGiven=true) then there SHALL be no reaction nor explanation.reason present
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
. . . identifier 0..* Identifier Business identifier
. . . status ?! Σ 1..1 code completed | entered-in-error
Immunization Status Codes (Required)
. . . notGiven ?! Σ 1..1 boolean Flag for whether immunization was given
. . . vaccineCode 1..1 CodeableConcept Vaccine product administered
Vaccine Administered Value Set (Example)
. . . patient 1..1 Reference(Patient) Who was immunized
. . . encounter 0..1 Reference(Encounter) Encounter administered as part of
. . . date 0..1 dateTime Vaccination administration date
. . . primarySource 1..1 boolean Indicates context the data was recorded in
. . . reportOrigin 0..1 CodeableConcept Indicates the source of a secondarily reported record
Immunization Origin Codes (Example)
. . . location 0..1 Reference(Location) Where vaccination occurred
. . . manufacturer 0..1 Reference(Organization) Vaccine manufacturer
. . . lotNumber 0..1 string Vaccine lot number
. . . expirationDate 0..1 date Vaccine expiration date
. . . site 0..1 CodeableConcept Body site vaccine was administered
Codes for Immunization Site of Administration (Example)
. . . route 0..1 CodeableConcept How vaccine entered body
Immunization Route Codes (Example)
. . . doseQuantity 0..1 SimpleQuantity Amount of vaccine administered
. . . practitioner Σ 0..* BackboneElement Who performed event
. . . . role Σ 0..1 CodeableConcept What type of performance was done
Immunization Role Codes (Extensible)
. . . . actor Σ 1..1 Reference(Practitioner) Individual who was performing
. . . note Σ 0..* Annotation Vaccination notes
. . . explanation 0..1 BackboneElement Administration/non-administration reasons
. . . . reason 0..* CodeableConcept Why immunization occurred
Immunization Reason Codes (Example)
. . . . reasonNotGiven 0..* CodeableConcept Why immunization did not occur
Immunization Reasons for Not Immunizing Codes (Example)
. . . reaction 0..* BackboneElement Details of a reaction that follows immunization
. . . . date 0..1 dateTime When reaction started
. . . . detail 0..1 Reference(Observation) Additional information on reaction
. . . . reported 0..1 boolean Indicates self-reported reaction
. . . vaccinationProtocol 0..* BackboneElement What protocol was followed
. . . . doseSequence 0..1 positiveInt Dose number within series
. . . . description 0..1 string Details of vaccine protocol
. . . . authority 0..1 Reference(Organization) Who is responsible for protocol
. . . . series 0..1 string Name of vaccine series
. . . . seriesDoses 0..1 positiveInt Recommended number of doses for immunity
. . . . targetDisease 1..* CodeableConcept Disease immunized against
Vaccination Protocol Dose Target Codes (Example)
. . . . doseStatus 1..1 CodeableConcept Indicates if dose counts towards immunity
Vaccination Protocol Dose Status codes (Example)
. . . . doseStatusReason 0..1 CodeableConcept Why dose does (not) count
Vaccination Protocol Dose Status Reason codes (Example)

doco Documentation for this format
Name Flags Card. Type Description & Constraints doco
. . ImmunizationRecommendation DomainResource Guidance or advice relating to an immunization
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
. . . identifier Σ 0..* Identifier Business identifier
. . . patient Σ 1..1 Reference(Patient) Who this profile is for
. . . recommendation Σ I 1..* BackboneElement Vaccine administration recommendations
+ One of vaccineCode or targetDisease SHALL be present
. . . . date Σ 1..1 dateTime Date recommendation created
. . . . vaccineCode Σ 0..1 CodeableConcept Vaccine recommendation applies to
Vaccine Administered Value Set (Example)
. . . . targetDisease Σ 0..1 CodeableConcept Disease to be immunized against
Immunization Recommendation Target Disease Codes (Example)
. . . . doseNumber Σ 0..1 positiveInt Recommended dose number
. . . . forecastStatus Σ 1..1 CodeableConcept Vaccine administration status
Immunization Recommendation Status Codes (Example)
. . . . dateCriterion 0..* BackboneElement Dates governing proposed immunization
. . . . . code 1..1 CodeableConcept Type of date
Immunization Recommendation Date Criterion Codes (Example)
. . . . . value 1..1 dateTime Recommended date
. . . . protocol 0..1 BackboneElement Protocol used by recommendation
. . . . . doseSequence 0..1 positiveInt Dose number within sequence
. . . . . description 0..1 string Protocol details
. . . . . authority 0..1 Reference(Organization) Who is responsible for protocol
. . . . . series 0..1 string Name of vaccination series
. . . . supportingImmunization 0..* Reference(Immunization) Past immunizations supporting recommendation
. . . . supportingPatientInformation 0..* Reference(Observation | AllergyIntolerance) Patient observations supporting recommendation

doco Documentation for this format
Name Flags Card. Type Description & Constraints doco
. . ImplementationGuide DomainResource A set of rules about how FHIR is used
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
. . . url Σ 1..1 uri Logical URI to reference this implementation guide (globally unique)
. . . version Σ 0..1 string Business version of the implementation guide
. . . name Σ 1..1 string Name for this implementation guide (computer friendly)
. . . status ?! Σ 1..1 code draft | active | retired | unknown
PublicationStatus (Required)
. . . experimental ?! Σ 0..1 boolean For testing purposes, not real usage
. . . date Σ 0..1 dateTime Date this was last changed
. . . publisher Σ 0..1 string Name of the publisher (organization or individual)
. . . contact Σ 0..* ContactDetail Contact details for the publisher
. . . description 0..1 markdown Natural language description of the implementation guide
. . . useContext Σ 0..* UsageContext Context the content is intended to support
. . . jurisdiction Σ 0..* CodeableConcept Intended jurisdiction for implementation guide (if applicable)
Jurisdiction ValueSet (Extensible)
. . . copyright 0..1 markdown Use and/or publishing restrictions
. . . fhirVersion Σ 0..1 id FHIR Version this Implementation Guide targets
. . . dependency Σ 0..* BackboneElement Another Implementation guide this depends on
. . . . type Σ 1..1 code reference | inclusion
GuideDependencyType (Required)
. . . . uri Σ 1..1 uri Where to find dependency
. . . package Σ 0..* BackboneElement Group of resources as used in .page.package
. . . . name Σ 1..1 string Name used .page.package
. . . . description 0..1 string Human readable text describing the package
. . . . resource Σ 1..* BackboneElement Resource in the implementation guide
. . . . . example Σ 1..1 boolean If not an example, has its normal meaning
. . . . . name Σ 0..1 string Human Name for the resource
. . . . . description 0..1 string Reason why included in guide
. . . . . acronym 0..1 string Short code to identify the resource
. . . . . source[x] Σ 1..1 Location of the resource
. . . . . . sourceUri uri
. . . . . . sourceReference Reference(Any)
. . . . . exampleFor 0..1 Reference(StructureDefinition) Resource this is an example of (if applicable)
. . . global Σ 0..* BackboneElement Profiles that apply globally
. . . . type Σ 1..1 code Type this profiles applies to
ResourceType (Required)
. . . . profile Σ 1..1 Reference(StructureDefinition) Profile that all resources must conform to
. . . binary 0..* uri Image, css, script, etc.
. . . page Σ 0..1 BackboneElement Page/Section in the Guide
. . . . source Σ 1..1 uri Where to find that page
. . . . title Σ 1..1 string Short title shown for navigational assistance
. . . . kind Σ 1..1 code page | example | list | include | directory | dictionary | toc | resource
GuidePageKind (Required)
. . . . type 0..* code Kind of resource to include in the list
ResourceType (Required)
. . . . package 0..* string Name of package to include
. . . . format 0..1 code Format of the page (e.g. html, markdown, etc.)
MimeType (Required)
. . . . page 0..* see page Nested Pages / Sections

doco Documentation for this format
Name Flags Card. Type Description & Constraints doco
. . Library DomainResource Represents a library of quality improvement components
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
. . . url Σ 0..1 uri Logical URI to reference this library (globally unique)
. . . identifier Σ 0..* Identifier Additional identifier for the library
. . . version Σ 0..1 string Business version of the library
. . . name Σ 0..1 string Name for this library (computer friendly)
. . . title Σ 0..1 string Name for this library (human friendly)
. . . status ?! Σ 1..1 code draft | active | retired | unknown
PublicationStatus (Required)
. . . experimental ?! Σ 0..1 boolean For testing purposes, not real usage
. . . type Σ 1..1 CodeableConcept logic-library | model-definition | asset-collection | module-definition
LibraryType (Extensible)
. . . date Σ 0..1 dateTime Date this was last changed
. . . publisher Σ 0..1 string Name of the publisher (organization or individual)
. . . description Σ 0..1 markdown Natural language description of the library
. . . purpose 0..1 markdown Why this library is defined
. . . usage 0..1 string Describes the clinical usage of the library
. . . approvalDate 0..1 date When the library was approved by publisher
. . . lastReviewDate 0..1 date When the library was last reviewed
. . . effectivePeriod Σ 0..1 Period When the library is expected to be used
. . . useContext Σ 0..* UsageContext Context the content is intended to support
. . . jurisdiction Σ 0..* CodeableConcept Intended jurisdiction for library (if applicable)
Jurisdiction ValueSet (Extensible)
. . . topic 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc
DefinitionTopic (Example)
. . . contributor 0..* Contributor A content contributor
. . . contact Σ 0..* ContactDetail Contact details for the publisher
. . . copyright 0..1 markdown Use and/or publishing restrictions
. . . relatedArtifact 0..* RelatedArtifact Additional documentation, citations, etc.
. . . parameter 0..* ParameterDefinition Parameters defined by the library
. . . dataRequirement 0..* DataRequirement What data is referenced by this library
. . . content 0..* Attachment Contents of the library, either embedded or referenced

doco Documentation for this format
Name Flags Card. Type Description & Constraints doco
. . Linkage Σ I DomainResource Links records for 'same' item
+ Must have at least two items
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
. . . active Σ 0..1 boolean Whether this linkage assertion is active or not
. . . author Σ 0..1 Reference(Practitioner | Organization) Who is responsible for linkages
. . . item Σ I 1..* BackboneElement Item to be linked
. . . . type Σ 1..1 code source | alternate | historical
LinkageType (Required)
. . . . resource Σ 1..1 Reference() Resource being linked

doco Documentation for this format
Name Flags Card. Type Description & Constraints doco
. . List I DomainResource Information summarized from a list of other resources
+ The deleted flag can only be used if the mode of the list is "changes"
+ A list can only have an emptyReason if it is empty
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
. . . identifier 0..* Identifier Business identifier
. . . status ?! Σ 1..1 code current | retired | entered-in-error
ListStatus (Required)
. . . mode ?! Σ 1..1 code working | snapshot | changes
ListMode (Required)
. . . title Σ 0..1 string Descriptive name for the list
. . . code Σ 0..1 CodeableConcept What the purpose of this list is
Example Use Codes for List (Example)
. . . subject Σ 0..1 Reference(Patient | Group | Device | Location) If all resources have the same subject
. . . encounter 0..1 Reference(Encounter) Context in which list created
. . . date Σ 0..1 dateTime When the list was prepared
. . . source Σ 0..1 Reference(Practitioner | Patient | Device) Who and/or what defined the list contents (aka Author)
. . . orderedBy 0..1 CodeableConcept What order the list has
List Order Codes (Preferred)
. . . note 0..* Annotation Comments about the list
. . . entry I 0..* BackboneElement Entries in the list
. . . . flag 0..1 CodeableConcept Status/Workflow information about this item
Patient Medicine Change Types (Example)
. . . . deleted ?! I 0..1 boolean If this item is actually marked as deleted
. . . . date 0..1 dateTime When item added to list
. . . . item 1..1 Reference(Any) Actual entry
. . . emptyReason I 0..1 CodeableConcept Why list is empty
List Empty Reasons (Preferred)

doco Documentation for this format
Name Flags Card. Type Description & Constraints doco
. . Location DomainResource Details and position information for a physical place
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
. . . identifier Σ 0..* Identifier Unique code or number identifying the location to its users
. . . status ?! Σ 0..1 code active | suspended | inactive
LocationStatus (Required)
. . . operationalStatus Σ 0..1 Coding The Operational status of the location (typically only for a bed/room)
v2 Bed Status (Preferred)
. . . name Σ 0..1 string Name of the location as used by humans
. . . alias 0..* string A list of alternate names that the location is known as, or was known as in the past
. . . description Σ 0..1 string Additional details about the location that could be displayed as further information to identify the location beyond its name
. . . mode ?! Σ 0..1 code instance | kind
LocationMode (Required)
. . . type Σ 0..1 CodeableConcept Type of function performed
ServiceDeliveryLocationRoleType (Extensible)
. . . telecom 0..* ContactPoint Contact details of the location
. . . address 0..1 Address Physical location
. . . physicalType Σ 0..1 CodeableConcept Physical form of the location
LocationType (Example)
. . . position 0..1 BackboneElement The absolute geographic location
. . . . longitude 1..1 decimal Longitude with WGS84 datum
. . . . latitude 1..1 decimal Latitude with WGS84 datum
. . . . altitude 0..1 decimal Altitude with WGS84 datum
. . . managingOrganization Σ 0..1 Reference(Organization) Organization responsible for provisioning and upkeep
. . . partOf 0..1 Reference(Location) Another Location this one is physically part of
. . . endpoint 0..* Reference(Endpoint) Technical endpoints providing access to services operated for the location

doco Documentation for this format
Name Flags Card. Type Description & Constraints doco
. . Measure DomainResource A quality measure definition
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
. . . url Σ 0..1 uri Logical URI to reference this measure (globally unique)
. . . identifier Σ 0..* Identifier Additional identifier for the measure
. . . version Σ 0..1 string Business version of the measure
. . . name Σ 0..1 string Name for this measure (computer friendly)
. . . title Σ 0..1 string Name for this measure (human friendly)
. . . status ?! Σ 1..1 code draft | active | retired | unknown
PublicationStatus (Required)
. . . experimental ?! Σ 0..1 boolean For testing purposes, not real usage
. . . date Σ 0..1 dateTime Date this was last changed
. . . publisher Σ 0..1 string Name of the publisher (organization or individual)
. . . description Σ 0..1 markdown Natural language description of the measure
. . . purpose 0..1 markdown Why this measure is defined
. . . usage 0..1 string Describes the clinical usage of the measure
. . . approvalDate 0..1 date When the measure was approved by publisher
. . . lastReviewDate 0..1 date When the measure was last reviewed
. . . effectivePeriod Σ 0..1 Period When the measure is expected to be used
. . . useContext Σ 0..* UsageContext Context the content is intended to support
. . . jurisdiction Σ 0..* CodeableConcept Intended jurisdiction for measure (if applicable)
Jurisdiction ValueSet (Extensible)
. . . topic 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc
DefinitionTopic (Example)
. . . contributor 0..* Contributor A content contributor
. . . contact Σ 0..* ContactDetail Contact details for the publisher
. . . copyright 0..1 markdown Use and/or publishing restrictions
. . . relatedArtifact 0..* RelatedArtifact Additional documentation, citations, etc
. . . library 0..* Reference(Library) Logic used by the measure
. . . disclaimer Σ 0..1 markdown Disclaimer for use of the measure or its referenced content
. . . scoring Σ 0..1 CodeableConcept proportion | ratio | continuous-variable | cohort
MeasureScoring (Extensible)
. . . compositeScoring Σ 0..1 CodeableConcept opportunity | all-or-nothing | linear | weighted
CompositeMeasureScoring (Extensible)
. . . type Σ 0..* CodeableConcept process | outcome | structure | patient-reported-outcome | composite
MeasureType (Extensible)
. . . riskAdjustment Σ 0..1 string How is risk adjustment applied for this measure
. . . rateAggregation Σ 0..1 string How is rate aggregation performed for this measure
. . . rationale Σ 0..1 markdown Why does this measure exist
. . . clinicalRecommendationStatement Σ 0..1 markdown Summary of clinical guidelines
. . . improvementNotation Σ 0..1 string Improvement notation for the measure, e.g. higher score indicates better quality
. . . definition Σ 0..* markdown Defined terms used in the measure documentation
. . . guidance Σ 0..1 markdown Additional guidance for implementers
. . . set Σ 0..1 string The measure set, e.g. Preventive Care and Screening
. . . group 0..* BackboneElement Population criteria group
. . . . identifier 1..1 Identifier Unique identifier
. . . . name 0..1 string Short name
. . . . description 0..1 string Summary description
. . . . population 0..* BackboneElement Population criteria
. . . . . identifier 0..1 Identifier Unique identifier
. . . . . code 0..1 CodeableConcept initial-population | numerator | numerator-exclusion | denominator | denominator-exclusion | denominator-exception | measure-population | measure-population-exclusion | measure-observation
MeasurePopulationType (Extensible)
. . . . . name 0..1 string Short name
. . . . . description 0..1 string The human readable description of this population criteria
. . . . . criteria 1..1 string The name of a valid referenced CQL expression (may be namespaced) that defines this population criteria
. . . . stratifier 0..* BackboneElement Stratifier criteria for the measure
. . . . . identifier 0..1 Identifier The identifier for the stratifier used to coordinate the reported data back to this stratifier
. . . . . criteria 0..1 string How the measure should be stratified
. . . . . path 0..1 string Path to the stratifier
. . . supplementalData 0..* BackboneElement What other data should be reported with the measure
. . . . identifier 0..1 Identifier Identifier, unique within the measure
. . . . usage 0..* CodeableConcept supplemental-data | risk-adjustment-factor
MeasureDataUsage (Extensible)
. . . . criteria 0..1 string Expression describing additional data to be reported
. . . . path 0..1 string Path to the supplemental data element

doco Documentation for this format
Name Flags Card. Type Description & Constraints doco
. . MeasureReport DomainResource Results of a measure evaluation
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
. . . identifier Σ 0..1 Identifier Additional identifier for the Report
. . . status ?! Σ 1..1 code complete | pending | error
MeasureReportStatus (Required)
. . . type Σ 1..1 code individual | patient-list | summary
MeasureReportType (Required)
. . . measure Σ 1..1 Reference(Measure) What measure was evaluated
. . . patient Σ 0..1 Reference(Patient) What patient the report is for
. . . date Σ 0..1 dateTime When the report was generated
. . . reportingOrganization Σ 0..1 Reference(Organization) Who is reporting the data
. . . period Σ 1..1 Period What period the report covers
. . . group 0..* BackboneElement Measure results for each group
. . . . identifier 1..1 Identifier What group of the measure
. . . . population 0..* BackboneElement The populations in the group
. . . . . identifier Σ 0..1 Identifier Population identifier as defined in the measure
. . . . . code Σ 0..1 CodeableConcept initial-population | numerator | numerator-exclusion | denominator | denominator-exclusion | denominator-exception | measure-population | measure-population-exclusion | measure-score
MeasurePopulationType (Extensible)
. . . . . count 0..1 integer Size of the population
. . . . . patients 0..1 Reference(List) For patient-list reports, the patients in this population
. . . . measureScore Σ 0..1 decimal What score this group achieved
. . . . stratifier 0..* BackboneElement Stratification results
. . . . . identifier 0..1 Identifier What stratifier of the group
. . . . . stratum 0..* BackboneElement Stratum results, one for each unique value in the stratifier
. . . . . . value 1..1 string The stratum value, e.g. male
. . . . . . population 0..* BackboneElement Population results in this stratum
. . . . . . . identifier Σ 0..1 Identifier Population identifier as defined in the measure
. . . . . . . code Σ 0..1 CodeableConcept initial-population | numerator | numerator-exclusion | denominator | denominator-exclusion | denominator-exception | measure-population | measure-population-exclusion | measure-score
MeasurePopulationType (Extensible)
. . . . . . . count 0..1 integer Size of the population
. . . . . . . patients 0..1 Reference(List) For patient-list reports, the patients in this population
. . . . . . measureScore Σ 0..1 decimal What score this stratum achieved
. . . evaluatedResources 0..1 Reference(Bundle) What data was evaluated to produce the measure score

doco Documentation for this format
Name Flags Card. Type Description & Constraints doco
. . Media I DomainResource A photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference
+ Height can only be used for a photo or video
+ Width can only be used for a photo or video
+ Frames can only be used for a photo
+ Duration can only be used for an audio or a video
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
. . . identifier Σ 0..* Identifier Identifier(s) for the image
. . . basedOn Σ 0..* Reference(ProcedureRequest) Procedure that caused this media to be created
. . . type Σ 1..1 code photo | video | audio
DigitalMediaType (Required)
. . . subtype Σ 0..1 CodeableConcept The type of acquisition equipment/process
Media SubType (Example)
. . . view Σ 0..1 CodeableConcept Imaging view, e.g. Lateral or Antero-posterior
Media Collection View/Projection (Example)
. . . subject Σ 0..1 Reference(Patient | Practitioner | Group | Device | Specimen) Who/What this Media is a record of
. . . context Σ 0..1 Reference(Encounter | EpisodeOfCare) Encounter / Episode associated with media
. . . occurrence[x] Σ 0..1 When Media was collected
. . . . occurrenceDateTime dateTime
. . . . occurrencePeriod Period
. . . operator Σ 0..1 Reference(Practitioner) The person who generated the image
. . . reasonCode Σ 0..* CodeableConcept Why was event performed?
Procedure Reason Codes (Example)
. . . bodySite Σ 0..1 CodeableConcept Body part in media
SNOMED CT Body Structures (Example)
. . . device Σ 0..1 Reference(Device | DeviceMetric) Observing Device
. . . height Σ I 0..1 positiveInt Height of the image in pixels (photo/video)
. . . width Σ I 0..1 positiveInt Width of the image in pixels (photo/video)
. . . frames Σ I 0..1 positiveInt Number of frames if > 1 (photo)
. . . duration Σ I 0..1 unsignedInt Length in seconds (audio / video)
. . . content 1..1 Attachment Actual Media - reference or data
. . . note 0..* Annotation Comments made about the media

doco Documentation for this format
Name Flags Card. Type Description & Constraints doco
. . Medication DomainResource Definition of a Medication
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
. . . code Σ 0..1 CodeableConcept Codes that identify this medication
SNOMED CT Medication Codes (Example)
. . . status Σ 0..1 code active | inactive | entered-in-error
MedicationStatus (Required)
. . . isBrand Σ 0..1 boolean True if a brand
. . . isOverTheCounter Σ 0..1 boolean True if medication does not require a prescription
. . . manufacturer Σ 0..1 Reference(Organization) Manufacturer of the item
. . . form 0..1 CodeableConcept powder | tablets | capsule +
SNOMED CT Form Codes (Example)
. . . ingredient 0..* BackboneElement Active or inactive ingredient
. . . . item[x] 1..1 The product contained
. . . . . itemCodeableConcept CodeableConcept
. . . . . itemReference Reference(Substance | Medication)
. . . . isActive 0..1 boolean Active ingredient indicator
. . . . amount 0..1 Ratio Quantity of ingredient present
. . . package 0..1 BackboneElement Details about packaged medications
. . . . container 0..1 CodeableConcept E.g. box, vial, blister-pack
MedicationContainer (Example)
. . . . content 0..* BackboneElement What is in the package
. . . . . item[x] 1..1 The item in the package
. . . . . . itemCodeableConcept CodeableConcept
. . . . . . itemReference Reference(Medication)
. . . . . amount 0..1 SimpleQuantity Quantity present in the package
. . . . batch 0..* BackboneElement Identifies a single production run
. . . . . lotNumber 0..1 string Identifier assigned to batch
. . . . . expirationDate 0..1 dateTime When batch will expire
. . . image 0..* Attachment Picture of the medication

doco Documentation for this format
Name Flags Card. Type Description & Constraints doco
. . MedicationAdministration I DomainResource Administration of medication to a patient
+ Reason not given is only permitted if NotGiven is true
+ Reason given is only permitted if NotGiven is false
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
. . . identifier 0..* Identifier External identifier
. . . definition Σ 0..* Reference(PlanDefinition | ActivityDefinition) Instantiates protocol or definition
. . . partOf Σ 0..* Reference(MedicationAdministration | Procedure) Part of referenced event
. . . status ?! Σ 1..1 code in-progress | on-hold | completed | entered-in-error | stopped | unknown
MedicationAdministrationStatus (Required)
. . . category 0..1 CodeableConcept Type of medication usage
MedicationAdministrationCategory (Preferred)
. . . medication[x] Σ 1..1 What was administered
SNOMED CT Medication Codes (Example)
. . . . medicationCodeableConcept CodeableConcept
. . . . medicationReference Reference(Medication)
. . . subject Σ 1..1 Reference(Patient | Group) Who received medication
. . . context 0..1 Reference(Encounter | EpisodeOfCare) Encounter or Episode of Care administered as part of
. . . supportingInformation 0..* Reference(Any) Additional information to support administration
. . . effective[x] Σ 1..1 Start and end time of administration
. . . . effectiveDateTime dateTime
. . . . effectivePeriod Period
. . . performer Σ 0..* BackboneElement Who administered substance
. . . . actor Σ 1..1 Reference(Practitioner | Patient | RelatedPerson | Device) Individual who was performing
. . . . onBehalfOf 0..1 Reference(Organization) Organization organization was acting for
. . . notGiven ?! Σ 0..1 boolean True if medication not administered
. . . reasonNotGiven I 0..* CodeableConcept Reason administration not performed
SNOMED CT Reason Medication Not Given Codes (Example)
. . . reasonCode I 0..* CodeableConcept Reason administration performed
Reason Medication Given Codes (Example)
. . . reasonReference 0..* Reference(Condition | Observation) Condition or Observation that supports why the medication was administered
. . . prescription 0..1 Reference(MedicationRequest) Request administration performed against
. . . device 0..* Reference(Device) Device used to administer
. . . note 0..* Annotation Information about the administration
. . . dosage I 0..1 BackboneElement Details of how medication was taken
+ SHALL have at least one of dosage.dose or dosage.rate[x]
. . . . text 0..1 string Free text dosage instructions e.g. SIG
. . . . site 0..1 CodeableConcept Body site administered to
SNOMED CT Anatomical Structure for Administration Site Codes (Example)
. . . . route 0..1 CodeableConcept Path of substance into body
SNOMED CT Route Codes (Example)
. . . . method 0..1 CodeableConcept How drug was administered
SNOMED CT Administration Method Codes (Example)
. . . . dose 0..1 SimpleQuantity Amount of medication per dose
. . . . rate[x] 0..1 Dose quantity per unit of time
. . . . . rateRatio Ratio
. . . . . rateQuantity SimpleQuantity
. . . eventHistory 0..* Reference(Provenance) A list of events of interest in the lifecycle

doco Documentation for this format
Name Flags Card. Type Description & Constraints doco
. . MedicationDispense I DomainResource Dispensing a medication to a named patient
+ whenHandedOver cannot be before whenPrepared
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
. . . identifier 0..* Identifier External identifier
. . . partOf 0..* Reference(Procedure) Event that dispense is part of
. . . status ?! Σ 0..1 code preparation | in-progress | on-hold | completed | entered-in-error | stopped
MedicationDispenseStatus (Required)
. . . category 0..1 CodeableConcept Type of medication dispense
MedicationDispenseCategory (Preferred)
. . . medication[x] Σ 1..1 What medication was supplied
SNOMED CT Medication Codes (Example)
. . . . medicationCodeableConcept CodeableConcept
. . . . medicationReference Reference(Medication)
. . . subject Σ 0..1 Reference(Patient | Group) Who the dispense is for
. . . context 0..1 Reference(Encounter | EpisodeOfCare) Encounter / Episode associated with event
. . . supportingInformation 0..* Reference(Any) Information that supports the dispensing of the medication
. . . performer 0..* BackboneElement Who performed event
. . . . actor 1..1 Reference(Practitioner | Organization | Patient | Device | RelatedPerson) Individual who was performing
. . . . onBehalfOf 0..1 Reference(Organization) Organization organization was acting for
. . . authorizingPrescription 0..* Reference(MedicationRequest) Medication order that authorizes the dispense
. . . type 0..1 CodeableConcept Trial fill, partial fill, emergency fill, etc.
ActPharmacySupplyType (Example)
. . . quantity 0..1 SimpleQuantity Amount dispensed
. . . daysSupply 0..1 SimpleQuantity Amount of medication expressed as a timing amount
. . . whenPrepared Σ 0..1 dateTime When product was packaged and reviewed
. . . whenHandedOver 0..1 dateTime When product was given out
. . . destination 0..1 Reference(Location) Where the medication was sent
. . . receiver 0..* Reference(Patient | Practitioner) Who collected the medication
. . . note 0..* Annotation Information about the dispense
. . . dosageInstruction 0..* Dosage How the medication is to be used by the patient or administered by the caregiver
. . . substitution 0..1 BackboneElement Whether a substitution was performed on the dispense
. . . . wasSubstituted 1..1 boolean Whether a substitution was or was not performed on the dispense
. . . . type 0..1 CodeableConcept Code signifying whether a different drug was dispensed from what was prescribed
ActSubstanceAdminSubstitutionCode (Example)
. . . . reason 0..* CodeableConcept Why was substitution made
SubstanceAdminSubstitutionReason (Example)
. . . . responsibleParty 0..* Reference(Practitioner) Who is responsible for the substitution
. . . detectedIssue 0..* Reference(DetectedIssue) Clinical issue with action
. . . notDone 0..1 boolean Whether the dispense was or was not performed
. . . notDoneReason[x] 0..1 Why a dispense was not performed
. . . . notDoneReasonCodeableConcept CodeableConcept
. . . . notDoneReasonReference Reference(DetectedIssue)
. . . eventHistory 0..* Reference(Provenance) A list of releveant lifecycle events

doco Documentation for this format
Name Flags Card. Type Description & Constraints doco
. . MedicationRequest DomainResource Ordering of medication for patient or group
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
. . . identifier 0..* Identifier External ids for this request
. . . definition Σ 0..* Reference(ActivityDefinition | PlanDefinition) Protocol or definition
. . . basedOn Σ 0..* Reference(CarePlan | MedicationRequest | ProcedureRequest | ReferralRequest) What request fulfills
. . . groupIdentifier Σ 0..1 Identifier Composite request this is part of
. . . status ?! Σ 0..1 code active | on-hold | cancelled | completed | entered-in-error | stopped | draft | unknown
MedicationRequestStatus (Required)
. . . intent ?! Σ 1..1 code proposal | plan | order | instance-order
MedicationRequestIntent (Required)
. . . category 0..1 CodeableConcept Type of medication usage
MedicationRequestCategory (Preferred)
. . . priority Σ 0..1 code routine | urgent | stat | asap
MedicationRequestPriority (Required)
. . . medication[x] Σ 1..1 Medication to be taken
SNOMED CT Medication Codes (Example)
. . . . medicationCodeableConcept CodeableConcept
. . . . medicationReference Reference(Medication)
. . . subject Σ 1..1 Reference(Patient | Group) Who or group medication request is for
. . . context 0..1 Reference(Encounter | EpisodeOfCare) Created during encounter/admission/stay
. . . supportingInformation 0..* Reference(Any) Information to support ordering of the medication
. . . authoredOn Σ 0..1 dateTime When request was initially authored
. . . requester Σ I 0..1 BackboneElement Who/What requested the Request
+ onBehalfOf can only be specified if agent is practitioner or device
. . . . agent Σ 1..1 Reference(Practitioner | Organization | Patient | RelatedPerson | Device) Who ordered the initial medication(s)
. . . . onBehalfOf Σ I 0..1 Reference(Organization) Organization agent is acting for
. . . recorder 0..1 Reference(Practitioner) Person who entered the request
. . . reasonCode 0..* CodeableConcept Reason or indication for writing the prescription
Condition/Problem/Diagnosis Codes (Example)
. . . reasonReference 0..* Reference(Condition | Observation) Condition or Observation that supports why the prescription is being written
. . . note 0..* Annotation Information about the prescription
. . . dosageInstruction 0..* Dosage How the medication should be taken
. . . dispenseRequest 0..1 BackboneElement Medication supply authorization
. . . . validityPeriod 0..1 Period Time period supply is authorized for
. . . . numberOfRepeatsAllowed 0..1 positiveInt Number of refills authorized
. . . . quantity 0..1 SimpleQuantity Amount of medication to supply per dispense
. . . . expectedSupplyDuration 0..1 Duration Number of days supply per dispense
. . . . performer 0..1 Reference(Organization) Intended dispenser
. . . substitution 0..1 BackboneElement Any restrictions on medication substitution
. . . . allowed ?! 1..1 boolean Whether substitution is allowed or not
. . . . reason 0..1 CodeableConcept Why should (not) substitution be made
SubstanceAdminSubstitutionReason (Example)
. . . priorPrescription 0..1 Reference(MedicationRequest) An order/prescription that is being replaced
. . . detectedIssue 0..* Reference(DetectedIssue) Clinical Issue with action
. . . eventHistory 0..* Reference(Provenance) A list of events of interest in the lifecycle

doco Documentation for this format
Name Flags Card. Type Description & Constraints doco
. . MedicationStatement I DomainResource Record of medication being taken by a patient
+ Reason not taken is only permitted if Taken is No
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
. . . identifier Σ 0..* Identifier External identifier
. . . basedOn Σ 0..* Reference(MedicationRequest | CarePlan | ProcedureRequest | ReferralRequest) Fulfils plan, proposal or order
. . . partOf Σ 0..* Reference(MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Observation) Part of referenced event
. . . context Σ 0..1 Reference(Encounter | EpisodeOfCare) Encounter / Episode associated with MedicationStatement
. . . status ?! Σ 1..1 code active | completed | entered-in-error | intended | stopped | on-hold
MedicationStatementStatus (Required)
. . . category Σ 0..1 CodeableConcept Type of medication usage
MedicationStatementCategory (Preferred)
. . . medication[x] Σ 1..1 What medication was taken
SNOMED CT Medication Codes (Example)
. . . . medicationCodeableConcept CodeableConcept
. . . . medicationReference Reference(Medication)
. . . effective[x] Σ 0..1 The date/time or interval when the medication was taken
. . . . effectiveDateTime dateTime
. . . . effectivePeriod Period
. . . dateAsserted Σ 0..1 dateTime When the statement was asserted?
. . . informationSource 0..1 Reference(Patient | Practitioner | RelatedPerson | Organization) Person or organization that provided the information about the taking of this medication
. . . subject Σ 1..1 Reference(Patient | Group) Who is/was taking the medication
. . . derivedFrom 0..* Reference(Any) Additional supporting information
. . . taken ?! Σ 1..1 code y | n | unk | na
MedicationStatementTaken (Required)
. . . reasonNotTaken I 0..* CodeableConcept True if asserting medication was not given
SNOMED CT Drugs not taken/completed Codes (Example)
. . . reasonCode 0..* CodeableConcept Reason for why the medication is being/was taken
Condition/Problem/Diagnosis Codes (Example)
. . . reasonReference 0..* Reference(Condition | Observation) Condition or observation that supports why the medication is being/was taken
. . . note 0..* Annotation Further information about the statement
. . . dosage 0..* Dosage Details of how medication is/was taken or should be taken

doco Documentation for this format
Name Flags Card. Type Description & Constraints doco
. . MessageDefinition DomainResource A resource that defines a type of message that can be exchanged between systems
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
. . . url Σ 0..1 uri Logical URI to reference this message definition (globally unique)
. . . identifier Σ 0..1 Identifier Additional identifier for the message definition
. . . version Σ 0..1 string Business version of the message definition
. . . name Σ 0..1 string Name for this message definition (computer friendly)
. . . title Σ 0..1 string Name for this message definition (human friendly)
. . . status ?! Σ 1..1 code draft | active | retired | unknown
PublicationStatus (Required)
. . . experimental ?! Σ 0..1 boolean For testing purposes, not real usage
. . . date Σ 1..1 dateTime Date this was last changed
. . . publisher Σ 0..1 string Name of the publisher (organization or individual)
. . . contact Σ 0..* ContactDetail Contact details for the publisher
. . . description Σ 0..1 markdown Natural language description of the message definition
. . . useContext Σ 0..* UsageContext Context the content is intended to support
. . . jurisdiction Σ 0..* CodeableConcept Intended jurisdiction for message definition (if applicable)
Jurisdiction ValueSet (Extensible)
. . . purpose Σ 0..1 markdown Why this message definition is defined
. . . copyright 0..1 markdown Use and/or publishing restrictions
. . . base Σ 0..1 Reference(MessageDefinition) Definition this one is based on
. . . parent Σ 0..* Reference(ActivityDefinition | PlanDefinition) Protocol/workflow this is part of
. . . replaces Σ 0..* Reference(MessageDefinition) Takes the place of
. . . event Σ 1..1 Coding Event type
MessageEvent (Example)
. . . category Σ 0..1 code Consequence | Currency | Notification
MessageSignificanceCategory (Required)
. . . focus Σ I 0..* BackboneElement Resource(s) that are the subject of the event
+ Max must be postive int or *
. . . . code Σ 1..1 code Type of resource
ResourceType (Required)
. . . . profile 0..1 Reference(StructureDefinition) Profile that must be adhered to by focus
. . . . min 0..1 unsignedInt Minimum number of focuses of this type
. . . . max I 0..1 string Maximum number of focuses of this type
. . . responseRequired 0..1 boolean Is a response required?
. . . allowedResponse 0..* BackboneElement Responses to this message
. . . . message 1..1 Reference(MessageDefinition) Reference to allowed message definition response
. . . . situation 0..1 markdown When should this response be used

doco Documentation for this format
Name Flags Card. Type Description & Constraints doco
. . MessageHeader Σ DomainResource A resource that describes a message that is exchanged between systems
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
. . . event Σ 1..1 Coding Code for the event this message represents
MessageEvent (Example)
. . . destination Σ 0..* BackboneElement Message destination application(s)
. . . . name Σ 0..1 string Name of system
. . . . target Σ 0..1 Reference(Device) Particular delivery destination within the destination
. . . . endpoint Σ 1..1 uri Actual destination address or id
. . . receiver Σ 0..1 Reference(Practitioner | Organization) Intended "real-world" recipient for the data
. . . sender Σ 0..1 Reference(Practitioner | Organization) Real world sender of the message
. . . timestamp Σ 1..1 instant Time that the message was sent
. . . enterer Σ 0..1 Reference(Practitioner) The source of the data entry
. . . author Σ 0..1 Reference(Practitioner) The source of the decision
. . . source Σ 1..1 BackboneElement Message source application
. . . . name Σ 0..1 string Name of system
. . . . software Σ 0..1 string Name of software running the system
. . . . version Σ 0..1 string Version of software running
. . . . contact Σ 0..1 ContactPoint Human contact for problems
. . . . endpoint Σ 1..1 uri Actual message source address or id
. . . responsible Σ 0..1 Reference(Practitioner | Organization) Final responsibility for event
. . . reason Σ 0..1 CodeableConcept Cause of event
Example Message Reason Codes (Example)
. . . response Σ 0..1 BackboneElement If this is a reply to prior message
. . . . identifier Σ 1..1 id Id of original message
. . . . code Σ 1..1 code ok | transient-error | fatal-error
ResponseType (Required)
. . . . details Σ 0..1 Reference(OperationOutcome) Specific list of hints/warnings/errors
. . . focus Σ 0..* Reference(Any) The actual content of the message

doco Documentation for this format
Name Flags Card. Type Description & Constraints doco
. . NamingSystem I DomainResource System of unique identification
+ Root systems cannot have uuid identifiers
+ Can only have replacedBy if naming system is retired
+ Can't have more than one preferred identifier for a type
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
. . . name Σ 1..1 string Name for this naming system (computer friendly)
. . . status ?! Σ 1..1 code draft | active | retired | unknown
PublicationStatus (Required)
. . . kind 1..1 code codesystem | identifier | root
NamingSystemType (Required)
. . . date Σ 1..1 dateTime Date this was last changed
. . . publisher Σ 0..1 string Name of the publisher (organization or individual)
. . . contact Σ 0..* ContactDetail Contact details for the publisher
. . . responsible 0..1 string Who maintains system namespace?
. . . type 0..1 CodeableConcept e.g. driver, provider, patient, bank etc.
Identifier Type Codes (Extensible)
. . . description 0..1 markdown Natural language description of the naming system
. . . useContext Σ 0..* UsageContext Context the content is intended to support
. . . jurisdiction Σ 0..* CodeableConcept Intended jurisdiction for naming system (if applicable)
Jurisdiction ValueSet (Extensible)
. . . usage 0..1 string How/where is it used
. . . uniqueId 1..* BackboneElement Unique identifiers used for system
. . . . type 1..1 code oid | uuid | uri | other
NamingSystemIdentifierType (Required)
. . . . value 1..1 string The unique identifier
. . . . preferred 0..1 boolean Is this the id that should be used for this type
. . . . comment 0..1 string Notes about identifier usage
. . . . period 0..1 Period When is identifier valid?
. . . replacedBy I 0..1 Reference(NamingSystem) Use this instead

doco Documentation for this format
Name Flags Card. Type Description & Constraints doco
. . NutritionOrder I DomainResource Diet, formula or nutritional supplement request
+ Nutrition Order SHALL contain either Oral Diet , Supplement, or Enteral Formula class
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
. . . identifier 0..* Identifier Identifiers assigned to this order
. . . status ?! Σ 0..1 code proposed | draft | planned | requested | active | on-hold | completed | cancelled | entered-in-error
NutritionOrderStatus (Required)
. . . patient Σ 1..1 Reference(Patient) The person who requires the diet, formula or nutritional supplement
. . . encounter 0..1 Reference(Encounter) The encounter associated with this nutrition order
. . . dateTime Σ 1..1 dateTime Date and time the nutrition order was requested
. . . orderer Σ 0..1 Reference(Practitioner) Who ordered the diet, formula or nutritional supplement
. . . allergyIntolerance 0..* Reference(AllergyIntolerance) List of the patient's food and nutrition-related allergies and intolerances
. . . foodPreferenceModifier 0..* CodeableConcept Order-specific modifier about the type of food that should be given
Diet (Example)
. . . excludeFoodModifier 0..* CodeableConcept Order-specific modifier about the type of food that should not be given
Food Type Codes (Example)
. . . oralDiet I 0..1 BackboneElement Oral diet components
. . . . type Σ 0..* CodeableConcept Type of oral diet or diet restrictions that describe what can be consumed orally
Diet Codes (Example)
. . . . schedule 0..* Timing Scheduled frequency of diet
. . . . nutrient 0..* BackboneElement Required nutrient modifications
. . . . . modifier 0..1 CodeableConcept Type of nutrient that is being modified
Nutrient Modifier Codes (Example)
. . . . . amount 0..1 SimpleQuantity Quantity of the specified nutrient
. . . . texture 0..* BackboneElement Required texture modifications
. . . . . modifier 0..1 CodeableConcept Code to indicate how to alter the texture of the foods, e.g. pureed
Texture Modifier Codes (Example)
. . . . . foodType 0..1 CodeableConcept Concepts that are used to identify an entity that is ingested for nutritional purposes
Texture Modified Food Type Codes (Example)
. . . . fluidConsistencyType 0..* CodeableConcept The required consistency of fluids and liquids provided to the patient
Fluid Consistency Type Codes (Example)
. . . . instruction Σ 0..1 string Instructions or additional information about the oral diet
. . . supplement I 0..* BackboneElement Supplement components
. . . . type Σ 0..1 CodeableConcept Type of supplement product requested
Supplement Type Codes (Example)
. . . . productName 0..1 string Product or brand name of the nutritional supplement
. . . . schedule 0..* Timing Scheduled frequency of supplement
. . . . quantity 0..1 SimpleQuantity Amount of the nutritional supplement
. . . . instruction Σ 0..1 string Instructions or additional information about the oral supplement
. . . enteralFormula I 0..1 BackboneElement Enteral formula components
. . . . baseFormulaType Σ 0..1 CodeableConcept Type of enteral or infant formula
Enteral Formula Type Codes (Example)
. . . . baseFormulaProductName 0..1 string Product or brand name of the enteral or infant formula
. . . . additiveType 0..1 CodeableConcept Type of modular component to add to the feeding
Enteral Formula Additive Type Code (Example)
. . . . additiveProductName 0..1 string Product or brand name of the modular additive
. . . . caloricDensity 0..1 SimpleQuantity Amount of energy per specified volume that is required
. . . . routeofAdministration 0..1 CodeableConcept How the formula should enter the patient's gastrointestinal tract
Enteral Route Codes (Extensible)
. . . . administration 0..* BackboneElement Formula feeding instruction as structured data
. . . . . schedule 0..1 Timing Scheduled frequency of enteral feeding
. . . . . quantity 0..1 SimpleQuantity The volume of formula to provide
. . . . . rate[x] 0..1 Speed with which the formula is provided per period of time
. . . . . . rateQuantity SimpleQuantity
. . . . . . rateRatio Ratio
. . . . maxVolumeToDeliver 0..1 SimpleQuantity Upper limit on formula volume per unit of time
. . . . administrationInstruction Σ 0..1 string Formula feeding instructions expressed as text

doco Documentation for this format
Name Flags Card. Type Description & Constraints doco
. . Observation I DomainResource Measurements and simple assertions
+ If code is the same as a component code then the value element associated with the code SHALL NOT be present
+ dataAbsentReason SHALL only be present if Observation.value[x] is not present
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
. . . identifier Σ 0..* Identifier Business Identifier for observation
. . . basedOn Σ 0..* Reference(CarePlan | DeviceRequest | ImmunizationRecommendation | MedicationRequest | NutritionOrder | ProcedureRequest | ReferralRequest) Fulfills plan, proposal or order
. . . status ?! Σ 1..1 code registered | preliminary | final | amended +
ObservationStatus (Required)
. . . category 0..* CodeableConcept Classification of type of observation
Observation Category Codes (Preferred)
. . . code Σ 1..1 CodeableConcept Type of observation (code / type)
LOINC Codes (Example)
. . . subject Σ 0..1 Reference(Patient | Group | Device | Location) Who and/or what this is about
. . . context 0..1 Reference(Encounter | EpisodeOfCare) Healthcare event during which this observation is made
. . . effective[x] Σ 0..1 Clinically relevant time/time-period for observation
. . . . effectiveDateTime dateTime
. . . . effectivePeriod Period
. . . issued Σ 0..1 instant Date/Time this was made available
. . . performer Σ 0..* Reference(Practitioner | Organization | Patient | RelatedPerson) Who is responsible for the observation
. . . value[x] Σ I 0..1 Actual result
. . . . valueQuantity Quantity
. . . . valueCodeableConcept CodeableConcept
. . . . valueString string
. . . . valueBoolean boolean
. . . . valueRange Range
. . . . valueRatio Ratio
. . . . valueSampledData SampledData
. . . . valueAttachment Attachment
. . . . valueTime time
. . . . valueDateTime dateTime
. . . . valuePeriod Period
. . . dataAbsentReason I 0..1 CodeableConcept Why the result is missing
Observation Value Absent Reason (Extensible)
. . . interpretation 0..1 CodeableConcept High, low, normal, etc.
Observation Interpretation Codes (Extensible)
. . . comment 0..1 string Comments about result
. . . bodySite 0..1 CodeableConcept Observed body part
SNOMED CT Body Structures (Example)
. . . method 0..1 CodeableConcept How it was done
Observation Methods (Example)
. . . specimen 0..1 Reference(Specimen) Specimen used for this observation
. . . device 0..1 Reference(Device | DeviceMetric) (Measurement) Device
. . . referenceRange I 0..* BackboneElement Provides guide for interpretation
+ Must have at least a low or a high or text
. . . . low I 0..1 SimpleQuantity Low Range, if relevant
. . . . high I 0..1 SimpleQuantity High Range, if relevant
. . . . type 0..1 CodeableConcept Reference range qualifier
Observation Reference Range Meaning Codes (Extensible)
. . . . appliesTo 0..* CodeableConcept Reference range population
Observation Reference Range Applies To Codes (Example)
. . . . age 0..1 Range Applicable age range, if relevant
. . . . text 0..1 string Text based reference range in an observation
. . . related Σ 0..* BackboneElement Resource related to this observation
. . . . type 0..1 code has-member | derived-from | sequel-to | replaces | qualified-by | interfered-by
ObservationRelationshipType (Required)
. . . . target 1..1 Reference(Observation | QuestionnaireResponse | Sequence) Resource that is related to this one
. . . component Σ 0..* BackboneElement Component results
. . . . code Σ 1..1 CodeableConcept Type of component observation (code / type)
LOINC Codes (Example)
. . . . value[x] Σ 0..1 Actual component result
. . . . . valueQuantity Quantity
. . . . . valueCodeableConcept CodeableConcept
. . . . . valueString string
. . . . . valueRange Range
. . . . . valueRatio Ratio
. . . . . valueSampledData SampledData
. . . . . valueAttachment Attachment
. . . . . valueTime time
. . . . . valueDateTime dateTime
. . . . . valuePeriod Period
. . . . dataAbsentReason I 0..1 CodeableConcept Why the component result is missing
Observation Value Absent Reason (Extensible)
. . . . interpretation 0..1 CodeableConcept High, low, normal, etc.
Observation Interpretation Codes (Extensible)
. . . . referenceRange 0..* see referenceRange Provides guide for interpretation of component result

doco Documentation for this format
Name Flags Card. Type Description & Constraints doco
. . OperationDefinition DomainResource Definition of an operation or a named query
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
. . . url Σ 0..1 uri Logical URI to reference this operation definition (globally unique)
. . . version Σ 0..1 string Business version of the operation definition
. . . name Σ 1..1 string Name for this operation definition (computer friendly)
. . . status ?! Σ 1..1 code draft | active | retired | unknown
PublicationStatus (Required)
. . . kind 1..1 code operation | query
OperationKind (Required)
. . . experimental ?! Σ 0..1 boolean For testing purposes, not real usage
. . . date Σ 0..1 dateTime Date this was last changed
. . . publisher Σ 0..1 string Name of the publisher (organization or individual)
. . . contact Σ 0..* ContactDetail Contact details for the publisher
. . . description 0..1 markdown Natural language description of the operation definition
. . . useContext Σ 0..* UsageContext Context the content is intended to support
. . . jurisdiction Σ 0..* CodeableConcept Intended jurisdiction for operation definition (if applicable)
Jurisdiction ValueSet (Extensible)
. . . purpose 0..1 markdown Why this operation definition is defined
. . . idempotent Σ 0..1 boolean Whether content is unchanged by the operation
. . . code Σ 1..1 code Name used to invoke the operation
. . . comment 0..1 string Additional information about use
. . . base Σ 0..1 Reference(OperationDefinition) Marks this as a profile of the base
. . . resource Σ 0..* code Types this operation applies to
ResourceType (Required)
. . . system Σ 1..1 boolean Invoke at the system level?
. . . type Σ 1..1 boolean Invole at the type level?
. . . instance Σ 1..1 boolean Invoke on an instance?
. . . parameter I 0..* BackboneElement Parameters for the operation/query
+ Either a type must be provided, or parts
+ A search type can only be specified for parameters of type string
. . . . name 1..1 code Name in Parameters.parameter.name or in URL
. . . . use 1..1 code in | out
OperationParameterUse (Required)
. . . . min 1..1 integer Minimum Cardinality
. . . . max 1..1 string Maximum Cardinality (a number or *)
. . . . documentation 0..1 string Description of meaning/use
. . . . type I 0..1 code What type this parameter has
FHIRAllTypes (Required)
. . . . searchType I 0..1 code number | date | string | token | reference | composite | quantity | uri
SearchParamType (Required)
. . . . profile 0..1 Reference(StructureDefinition) Profile on the type
. . . . binding 0..1 BackboneElement ValueSet details if this is coded
. . . . . strength 1..1 code required | extensible | preferred | example
BindingStrength (Required)
. . . . . valueSet[x] 1..1 Source of value set
. . . . . . valueSetUri uri
. . . . . . valueSetReference Reference(ValueSet)
. . . . part I 0..* see parameter Parts of a nested Parameter
. . . overload 0..* BackboneElement Define overloaded variants for when generating code
. . . . parameterName 0..* string Name of parameter to include in overload
. . . . comment 0..1 string Comments to go on overload

doco Documentation for this format
Name Flags Card. Type Description & Constraints doco
. . OperationOutcome Σ DomainResource Information about the success/failure of an action
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
. . . issue Σ 1..* BackboneElement A single issue associated with the action
. . . . severity ?! Σ 1..1 code fatal | error | warning | information
IssueSeverity (Required)
. . . . code Σ 1..1 code Error or warning code
IssueType (Required)
. . . . details Σ 0..1 CodeableConcept Additional details about the error
Operation Outcome Codes (Example)
. . . . diagnostics Σ 0..1 string Additional diagnostic information about the issue
. . . . location Σ 0..* string Path of element(s) related to issue
. . . . expression Σ 0..* string FHIRPath of element(s) related to issue

doco Documentation for this format
Name Flags Card. Type Description & Constraints doco
. . Organization I DomainResource A grouping of people or organizations with a common purpose
+ The organization SHALL at least have a name or an id, and possibly more than one
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
. . . identifier Σ I 0..* Identifier Identifies this organization across multiple systems
. . . active ?! Σ 0..1 boolean Whether the organization's record is still in active use
. . . type Σ 0..* CodeableConcept Kind of organization
OrganizationType (Example)
. . . name Σ I 0..1 string Name used for the organization
. . . alias 0..* string A list of alternate names that the organization is known as, or was known as in the past
. . . telecom I 0..* ContactPoint A contact detail for the organization
+ The telecom of an organization can never be of use 'home'
. . . address I 0..* Address An address for the organization
+ An address of an organization can never be of use 'home'
. . . partOf Σ 0..1 Reference(Organization) The organization of which this organization forms a part
. . . contact 0..* BackboneElement Contact for the organization for a certain purpose
. . . . purpose 0..1 CodeableConcept The type of contact
ContactEntityType (Extensible)
. . . . name 0..1 HumanName A name associated with the contact
. . . . telecom 0..* ContactPoint Contact details (telephone, email, etc.) for a contact
. . . . address 0..1 Address Visiting or postal addresses for the contact
. . . endpoint 0..* Reference(Endpoint) Technical endpoints providing access to services operated for the organization

doco Documentation for this format
Name Flags Card. Type Description & Constraints doco
. . Parameters Σ Resource Operation Request or Response
Elements defined in Ancestors: id, meta, implicitRules, language
. . . parameter Σ I 0..* BackboneElement Operation Parameter
+ A parameter must have only one of (value, resource, part)
. . . . name Σ 1..1 string Name from the definition
. . . . value[x] Σ I 0..1 * If parameter is a data type
. . . . resource Σ I 0..1 Resource If parameter is a whole resource
. . . . part Σ 0..* see parameter Named part of a multi-part parameter

doco Documentation for this format
Name Flags Card. Type Description & Constraints doco
. . Patient DomainResource Information about an individual or animal receiving health care services
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
. . . identifier Σ 0..* Identifier An identifier for this patient
. . . active ?! Σ 0..1 boolean Whether this patient's record is in active use
. . . name Σ 0..* HumanName A name associated with the patient
. . . telecom Σ 0..* ContactPoint A contact detail for the individual
. . . gender Σ 0..1 code male | female | other | unknown
AdministrativeGender (Required)
. . . birthDate Σ 0..1 date The date of birth for the individual
. . . deceased[x] ?! Σ 0..1 Indicates if the individual is deceased or not
. . . . deceasedBoolean boolean
. . . . deceasedDateTime dateTime
. . . address Σ 0..* Address Addresses for the individual
. . . maritalStatus 0..1 CodeableConcept Marital (civil) status of a patient
Marital Status Codes (Extensible)
. . . multipleBirth[x] 0..1 Whether patient is part of a multiple birth
. . . . multipleBirthBoolean boolean
. . . . multipleBirthInteger integer
. . . photo 0..* Attachment Image of the patient
. . . contact I 0..* BackboneElement A contact party (e.g. guardian, partner, friend) for the patient
+ SHALL at least contain a contact's details or a reference to an organization
. . . . relationship 0..* CodeableConcept The kind of relationship
v2 Contact Role (Extensible)
. . . . name 0..1 HumanName A name associated with the contact person
. . . . telecom 0..* ContactPoint A contact detail for the person
. . . . address 0..1 Address Address for the contact person
. . . . gender 0..1 code male | female | other | unknown
AdministrativeGender (Required)
. . . . organization I 0..1 Reference(Organization) Organization that is associated with the contact
. . . . period 0..1 Period The period during which this contact person or organization is valid to be contacted relating to this patient
. . . animal ?! Σ 0..1 BackboneElement This patient is known to be an animal (non-human)
. . . . species Σ 1..1 CodeableConcept E.g. Dog, Cow
AnimalSpecies (Example)
. . . . breed Σ 0..1 CodeableConcept E.g. Poodle, Angus
AnimalBreeds (Example)
. . . . genderStatus Σ 0..1 CodeableConcept E.g. Neutered, Intact
GenderStatus (Example)
. . . communication 0..* BackboneElement A list of Languages which may be used to communicate with the patient about his or her health
. . . . language 1..1 CodeableConcept The language which can be used to communicate with the patient about his or her health
Common Languages (Extensible but limited to All Languages)
. . . . preferred 0..1 boolean Language preference indicator
. . . generalPractitioner 0..* Reference(Organization | Practitioner) Patient's nominated primary care provider
. . . managingOrganization Σ 0..1 Reference(Organization) Organization that is the custodian of the patient record
. . . link ?! Σ 0..* BackboneElement Link to another patient resource that concerns the same actual person
. . . . other Σ 1..1 Reference(Patient | RelatedPerson) The other patient or related person resource that the link refers to
. . . . type Σ 1..1 code replaced-by | replaces | refer | seealso - type of link
LinkType (Required)

doco Documentation for this format
Name Flags Card. Type Description & Constraints doco
. . PaymentNotice DomainResource PaymentNotice request
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
. . . identifier 0..* Identifier Business Identifier
. . . status ?! Σ 0..1 code active | cancelled | draft | entered-in-error
Financial Resource Status Codes (Required)
. . . request 0..1 Reference(Any) Request reference
. . . response 0..1 Reference(Any) Response reference
. . . statusDate 0..1 date Payment or clearing date
. . . created 0..1 dateTime Creation date
. . . target 0..1 Reference(Organization) Insurer or Regulatory body
. . . provider 0..1 Reference(Practitioner) Responsible practitioner
. . . organization 0..1 Reference(Organization) Responsible organization
. . . paymentStatus 0..1 CodeableConcept Whether payment has been sent or cleared
Payment Status Codes (Example)

doco Documentation for this format
Name Flags Card. Type Description & Constraints doco
. . PaymentReconciliation DomainResource PaymentReconciliation resource
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
. . . identifier 0..* Identifier Business Identifier
. . . status ?! Σ 0..1 code active | cancelled | draft | entered-in-error
Financial Resource Status Codes (Required)
. . . period 0..1 Period Period covered
. . . created 0..1 dateTime Creation date
. . . organization 0..1 Reference(Organization) Insurer
. . . request 0..1 Reference(ProcessRequest) Claim reference
. . . outcome 0..1 CodeableConcept complete | error | partial
RemittanceOutcome (Required)
. . . disposition 0..1 string Disposition Message
. . . requestProvider 0..1 Reference(Practitioner) Responsible practitioner
. . . requestOrganization 0..1 Reference(Organization) Responsible organization
. . . detail 0..* BackboneElement List of settlements
. . . . type 1..1 CodeableConcept Type code
Payment Type Codes (Example)
. . . . request 0..1 Reference(Any) Claim
. . . . response 0..1 Reference(Any) Claim Response
. . . . submitter 0..1 Reference(Organization) Organization which submitted the claim
. . . . payee 0..1 Reference(Organization) Organization which is receiving the payment
. . . . date 0..1 date Invoice date
. . . . amount 0..1 Money Amount being paid
. . . form 0..1 CodeableConcept Printed Form Identifier
Form Codes (Example)
. . . total 0..1 Money Total amount of Payment
. . . processNote 0..* BackboneElement Processing comments
. . . . type 0..1 CodeableConcept display | print | printoper
NoteType (Required)
. . . . text 0..1 string Comment on the processing

doco Documentation for this format
Name Flags Card. Type Description & Constraints doco
. . Person DomainResource A generic person record
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
. . . identifier 0..* Identifier A human identifier for this person
. . . name Σ 0..* HumanName A name associated with the person
. . . telecom Σ 0..* ContactPoint A contact detail for the person
. . . gender Σ 0..1 code male | female | other | unknown
AdministrativeGender (Required)
. . . birthDate Σ 0..1 date The date on which the person was born
. . . address 0..* Address One or more addresses for the person
. . . photo 0..1 Attachment Image of the person
. . . managingOrganization Σ 0..1 Reference(Organization) The organization that is the custodian of the person record
. . . active ?! Σ 0..1 boolean This person's record is in active use
. . . link 0..* BackboneElement Link to a resource that concerns the same actual person
. . . . target 1..1 Reference(Patient | Practitioner | RelatedPerson | Person) The resource to which this actual person is associated
. . . . assurance 0..1 code level1 | level2 | level3 | level4
IdentityAssuranceLevel (Required)

doco Documentation for this format
Name Flags Card. Type Description & Constraints doco
. . PlanDefinition DomainResource The definition of a plan for a series of actions, independent of any specific patient or context
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
. . . url Σ 0..1 uri Logical URI to reference this plan definition (globally unique)
. . . identifier Σ 0..* Identifier Additional identifier for the plan definition
. . . version Σ 0..1 string Business version of the plan definition
. . . name Σ 0..1 string Name for this plan definition (computer friendly)
. . . title Σ 0..1 string Name for this plan definition (human friendly)
. . . type Σ 0..1 CodeableConcept order-set | protocol | eca-rule
PlanDefinitionType (Extensible)
. . . status ?! Σ 1..1 code draft | active | retired | unknown
PublicationStatus (Required)
. . . experimental ?! Σ 0..1 boolean For testing purposes, not real usage
. . . date Σ 0..1 dateTime Date this was last changed
. . . publisher Σ 0..1 string Name of the publisher (organization or individual)
. . . description Σ 0..1 markdown Natural language description of the plan definition
. . . purpose 0..1 markdown Why this plan definition is defined
. . . usage 0..1 string Describes the clinical usage of the asset
. . . approvalDate 0..1 date When the plan definition was approved by publisher
. . . lastReviewDate 0..1 date When the plan definition was last reviewed
. . . effectivePeriod Σ 0..1 Period When the plan definition is expected to be used
. . . useContext Σ 0..* UsageContext Context the content is intended to support
. . . jurisdiction Σ 0..* CodeableConcept Intended jurisdiction for plan definition (if applicable)
Jurisdiction ValueSet (Extensible)
. . . topic 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc
DefinitionTopic (Example)
. . . contributor 0..* Contributor A content contributor
. . . contact Σ 0..* ContactDetail Contact details for the publisher
. . . copyright 0..1 markdown Use and/or publishing restrictions
. . . relatedArtifact 0..* RelatedArtifact Related artifacts for the asset
. . . library 0..* Reference(Library) Logic used by the plan definition
. . . goal 0..* BackboneElement What the plan is trying to accomplish
. . . . category 0..1 CodeableConcept E.g. Treatment, dietary, behavioral, etc
GoalCategory (Example)
. . . . description 1..1 CodeableConcept Code or text describing the goal
SNOMED CT Clinical Findings (Example)
. . . . priority 0..1 CodeableConcept high-priority | medium-priority | low-priority
GoalPriority (Preferred)
. . . . start 0..1 CodeableConcept When goal pursuit begins
GoalStartEvent (Example)
. . . . addresses 0..* CodeableConcept What does the goal address
Condition/Problem/Diagnosis Codes (Example)
. . . . documentation 0..* RelatedArtifact Supporting documentation for the goal
. . . . target 0..* BackboneElement Target outcome for the goal
. . . . . measure 0..1 CodeableConcept The parameter whose value is to be tracked
LOINC Codes (Example)
. . . . . detail[x] 0..1 The target value to be achieved
. . . . . . detailQuantity Quantity
. . . . . . detailRange Range
. . . . . . detailCodeableConcept CodeableConcept
. . . . . due 0..1 Duration Reach goal within
. . . action 0..* BackboneElement Action defined by the plan
. . . . label 0..1 string User-visible label for the action (e.g. 1. or A.)
. . . . title 0..1 string User-visible title
. . . . description 0..1 string Short description of the action
. . . . textEquivalent 0..1 string Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system
. . . . code 0..* CodeableConcept Code representing the meaning of the action or sub-actions
. . . . reason 0..* CodeableConcept Why the action should be performed
. . . . documentation 0..* RelatedArtifact Supporting documentation for the intended performer of the action
. . . . goalId 0..* id What goals this action supports
. . . . triggerDefinition 0..* TriggerDefinition When the action should be triggered
. . . . condition 0..* BackboneElement Whether or not the action is applicable
. . . . . kind 1..1 code applicability | start | stop
ActionConditionKind (Required)
. . . . . description 0..1 string Natural language description of the condition
. . . . . language 0..1 string Language of the expression
. . . . . expression 0..1 string Boolean-valued expression
. . . . input 0..* DataRequirement Input data requirements
. . . . output 0..* DataRequirement Output data definition
. . . . relatedAction 0..* BackboneElement Relationship to another action
. . . . . actionId 1..1 id What action is this related to
. . . . . relationship 1..1 code before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end
ActionRelationshipType (Required)
. . . . . offset[x] 0..1 Time offset for the relationship
. . . . . . offsetDuration Duration
. . . . . . offsetRange Range
. . . . timing[x] 0..1 When the action should take place
. . . . . timingDateTime dateTime
. . . . . timingPeriod Period
. . . . . timingDuration Duration
. . . . . timingRange Range
. . . . . timingTiming Timing
. . . . participant 0..* BackboneElement Who should participate in the action
. . . . . type 1..1 code patient | practitioner | related-person
ActionParticipantType (Required)
. . . . . role 0..1 CodeableConcept E.g. Nurse, Surgeon, Parent, etc
ActionParticipantRole (Example)
. . . . type 0..1 Coding create | update | remove | fire-event
ActionType (Required)
. . . . groupingBehavior 0..1 code visual-group | logical-group | sentence-group
ActionGroupingBehavior (Required)
. . . . selectionBehavior 0..1 code any | all | all-or-none | exactly-one | at-most-one | one-or-more
ActionSelectionBehavior (Required)
. . . . requiredBehavior 0..1 code must | could | must-unless-documented
ActionRequiredBehavior (Required)
. . . . precheckBehavior 0..1 code yes | no
ActionPrecheckBehavior (Required)
. . . . cardinalityBehavior 0..1 code single | multiple
ActionCardinalityBehavior (Required)
. . . . definition 0..1 Reference(ActivityDefinition | PlanDefinition) Description of the activity to be performed
. . . . transform 0..1 Reference(StructureMap) Transform to apply the template
. . . . dynamicValue 0..* BackboneElement Dynamic aspects of the definition
. . . . . description 0..1 string Natural language description of the dynamic value
. . . . . path 0..1 string The path to the element to be set dynamically
. . . . . language 0..1 string Language of the expression
. . . . . expression 0..1 string An expression that provides the dynamic value for the customization
. . . . action 0..* see action A sub-action

doco Documentation for this format
Name Flags Card. Type Description & Constraints doco
. . Practitioner DomainResource A person with a formal responsibility in the provisioning of healthcare or related services
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
. . . identifier Σ 0..* Identifier A identifier for the person as this agent
. . . active Σ 0..1 boolean Whether this practitioner's record is in active use
. . . name Σ 0..* HumanName The name(s) associated with the practitioner
. . . telecom Σ 0..* ContactPoint A contact detail for the practitioner (that apply to all roles)
. . . address Σ 0..* Address Address(es) of the practitioner that are not role specific (typically home address)
. . . gender Σ 0..1 code male | female | other | unknown
AdministrativeGender (Required)
. . . birthDate Σ 0..1 date The date on which the practitioner was born
. . . photo 0..* Attachment Image of the person
. . . qualification 0..* BackboneElement Qualifications obtained by training and certification
. . . . identifier 0..* Identifier An identifier for this qualification for the practitioner
. . . . code 1..1 CodeableConcept Coded representation of the qualification
v2 table 0360, Version 2.7 (Example)
. . . . period 0..1 Period Period during which the qualification is valid
. . . . issuer 0..1 Reference(Organization) Organization that regulates and issues the qualification
. . . communication 0..* CodeableConcept A language the practitioner is able to use in patient communication
Common Languages (Extensible but limited to All Languages)

doco Documentation for this format
Name Flags Card. Type Description & Constraints doco
. . PractitionerRole DomainResource Roles/organizations the practitioner is associated with
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
. . . identifier Σ 0..* Identifier Business Identifiers that are specific to a role/location
. . . active Σ 0..1 boolean Whether this practitioner's record is in active use
. . . period Σ 0..1 Period The period during which the practitioner is authorized to perform in these role(s)
. . . practitioner Σ 0..1 Reference(Practitioner) Practitioner that is able to provide the defined services for the organation
. . . organization Σ 0..1 Reference(Organization) Organization where the roles are available
. . . code Σ 0..* CodeableConcept Roles which this practitioner may perform
PractitionerRole (Example)
. . . specialty Σ 0..* CodeableConcept Specific specialty of the practitioner
Practice Setting Code Value Set (Preferred)
. . . location Σ 0..* Reference(Location) The location(s) at which this practitioner provides care
. . . healthcareService 0..* Reference(HealthcareService) The list of healthcare services that this worker provides for this role's Organization/Location(s)
. . . telecom Σ 0..* ContactPoint Contact details that are specific to the role/location/service
. . . availableTime 0..* BackboneElement Times the Service Site is available
. . . . daysOfWeek 0..* code mon | tue | wed | thu | fri | sat | sun
DaysOfWeek (Required)
. . . . allDay 0..1 boolean Always available? e.g. 24 hour service
. . . . availableStartTime 0..1 time Opening time of day (ignored if allDay = true)
. . . . availableEndTime 0..1 time Closing time of day (ignored if allDay = true)
. . . notAvailable 0..* BackboneElement Not available during this time due to provided reason
. . . . description 1..1 string Reason presented to the user explaining why time not available
. . . . during 0..1 Period Service not availablefrom this date
. . . availabilityExceptions 0..1 string Description of availability exceptions
. . . endpoint 0..* Reference(Endpoint) Technical endpoints providing access to services operated for the practitioner with this role

doco Documentation for this format
Name Flags Card. Type Description & Constraints doco
. . Procedure I DomainResource An action that is being or was performed on a patient
+ Reason not done is only permitted if notDone indicator is true
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
. . . identifier Σ 0..* Identifier External Identifiers for this procedure
. . . definition Σ 0..* Reference(PlanDefinition | ActivityDefinition | HealthcareService) Instantiates protocol or definition
. . . basedOn Σ 0..* Reference(CarePlan | ProcedureRequest | ReferralRequest) A request for this procedure
. . . partOf Σ 0..* Reference(Procedure | Observation | MedicationAdministration) Part of referenced event
. . . status ?! Σ 1..1 code preparation | in-progress | suspended | aborted | completed | entered-in-error | unknown
EventStatus (Required)
. . . notDone ?! Σ 0..1 boolean True if procedure was not performed as scheduled
. . . notDoneReason Σ I 0..1 CodeableConcept Reason procedure was not performed
Procedure Not Performed Reason (SNOMED-CT) (Example)
. . . category Σ 0..1 CodeableConcept Classification of the procedure
Procedure Category Codes (SNOMED CT) (Example)
. . . code Σ 0..1 CodeableConcept Identification of the procedure
Procedure Codes (SNOMED CT) (Example)
. . . subject Σ 1..1 Reference(Patient | Group) Who the procedure was performed on
. . . context Σ 0..1 Reference(Encounter | EpisodeOfCare) Encounter or episode associated with the procedure
. . . performed[x] Σ 0..1 Date/Period the procedure was performed
. . . . performedDateTime dateTime
. . . . performedPeriod Period
. . . performer Σ 0..* BackboneElement The people who performed the procedure
. . . . role Σ 0..1 CodeableConcept The role the actor was in
Procedure Performer Role Codes (Example)
. . . . actor Σ 1..1 Reference(Practitioner | Organization | Patient | RelatedPerson | Device) The reference to the practitioner
. . . . onBehalfOf 0..1 Reference(Organization) Organization the device or practitioner was acting for
. . . location Σ 0..1 Reference(Location) Where the procedure happened
. . . reasonCode Σ 0..* CodeableConcept Coded reason procedure performed
Procedure Reason Codes (Example)
. . . reasonReference Σ 0..* Reference(Condition | Observation) Condition that is the reason the procedure performed
. . . bodySite Σ 0..* CodeableConcept Target body sites
SNOMED CT Body Structures (Example)
. . . outcome Σ 0..1 CodeableConcept The result of procedure
Procedure Outcome Codes (SNOMED CT) (Example)
. . . report 0..* Reference(DiagnosticReport) Any report resulting from the procedure
. . . complication 0..* CodeableConcept Complication following the procedure
Condition/Problem/Diagnosis Codes (Example)
. . . complicationDetail 0..* Reference(Condition) A condition that is a result of the procedure
. . . followUp 0..* CodeableConcept Instructions for follow up
Procedure Follow up Codes (SNOMED CT) (Example)
. . . note 0..* Annotation Additional information about the procedure
. . . focalDevice 0..* BackboneElement Device changed in procedure
. . . . action 0..1 CodeableConcept Kind of change to device
Procedure Device Action Codes (Preferred)
. . . . manipulated 1..1 Reference(Device) Device that was changed
. . . usedReference 0..* Reference(Device | Medication | Substance) Items used during procedure
. . . usedCode 0..* CodeableConcept Coded items used during the procedure
FHIR Device Types (Example)

doco Documentation for this format
Name Flags Card. Type Description & Constraints doco
. . ProcedureRequest DomainResource A request for a procedure or diagnostic to be performed
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
. . . identifier Σ 0..* Identifier Identifiers assigned to this order
. . . definition Σ 0..* Reference(ActivityDefinition | PlanDefinition) Protocol or definition
. . . basedOn Σ 0..* Reference(Any) What request fulfills
. . . replaces Σ 0..* Reference(Any) What request replaces
. . . requisition Σ 0..1 Identifier Composite Request ID
. . . status ?! Σ 1..1 code draft | active | suspended | completed | entered-in-error | cancelled
RequestStatus (Required)
. . . intent ?! Σ 1..1 code proposal | plan | order +
RequestIntent (Required)
. . . priority Σ 0..1 code routine | urgent | asap | stat
RequestPriority (Required)
. . . doNotPerform ?! Σ 0..1 boolean True if procedure should not be performed
. . . category Σ 0..* CodeableConcept Classification of procedure
Procedure Category Codes (SNOMED CT) (Example)
. . . code Σ 1..1 CodeableConcept What is being requested/ordered
Procedure Codes (SNOMED CT) (Example)
. . . subject Σ 1..1 Reference(Patient | Group | Location | Device) Individual the service is ordered for
. . . context Σ 0..1 Reference(Encounter | EpisodeOfCare) Encounter or Episode during which request was created
. . . occurrence[x] Σ 0..1 When procedure should occur
. . . . occurrenceDateTime dateTime
. . . . occurrencePeriod Period
. . . . occurrenceTiming Timing
. . . asNeeded[x] Σ 0..1 Preconditions for procedure or diagnostic
SNOMED CT Medication As Needed Reason Codes (Example)
. . . . asNeededBoolean boolean
. . . . asNeededCodeableConcept CodeableConcept
. . . authoredOn Σ 0..1 dateTime Date request signed
. . . requester Σ 0..1 BackboneElement Who/what is requesting procedure or diagnostic
. . . . agent Σ 1..1 Reference(Device | Practitioner | Organization) Individual making the request
. . . . onBehalfOf Σ 0..1 Reference(Organization) Organization agent is acting for
. . . performerType Σ 0..1 CodeableConcept Performer role
Participant Roles (Example)
. . . performer Σ 0..1 Reference(Practitioner | Organization | Patient | Device | RelatedPerson | HealthcareService) Requested perfomer
. . . reasonCode Σ 0..* CodeableConcept Explanation/Justification for test
Procedure Reason Codes (Example)
. . . reasonReference Σ 0..* Reference(Condition | Observation) Explanation/Justification for test
. . . supportingInfo 0..* Reference(Any) Additional clinical information
. . . specimen Σ 0..* Reference(Specimen) Procedure Samples
. . . bodySite Σ 0..* CodeableConcept Location on Body
SNOMED CT Body Structures (Example)
. . . note 0..* Annotation Comments
. . . relevantHistory 0..* Reference(Provenance) Request provenance

doco Documentation for this format
Name Flags Card. Type Description & Constraints doco
. . ProcessRequest DomainResource Request to perform some action on or in regards to an existing resource
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
. . . identifier 0..* Identifier Business Identifier
. . . status ?! Σ 0..1 code active | cancelled | draft | entered-in-error
Financial Resource Status Codes (Required)
. . . action 0..1 code cancel | poll | reprocess | status
ActionList (Required)
. . . target 0..1 Reference(Organization) Party which is the target of the request
. . . created 0..1 dateTime Creation date
. . . provider 0..1 Reference(Practitioner) Responsible practitioner
. . . organization 0..1 Reference(Organization) Responsible organization
. . . request 0..1 Reference(Any) Reference to the Request resource
. . . response 0..1 Reference(Any) Reference to the Response resource
. . . nullify 0..1 boolean Remove history
. . . reference 0..1 string Reference number/string
. . . item 0..* BackboneElement Items to re-adjudicate
. . . . sequenceLinkId 1..1 integer Service instance
. . . include 0..* string Resource type(s) to include
. . . exclude 0..* string Resource type(s) to exclude
. . . period 0..1 Period Selection period

doco Documentation for this format
Name Flags Card. Type Description & Constraints doco
. . ProcessResponse DomainResource ProcessResponse resource
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
. . . identifier 0..* Identifier Business Identifier
. . . status ?! Σ 0..1 code active | cancelled | draft | entered-in-error
Financial Resource Status Codes (Required)
. . . created 0..1 dateTime Creation date
. . . organization 0..1 Reference(Organization) Authoring Organization
. . . request 0..1 Reference(Any) Request reference
. . . outcome 0..1 CodeableConcept Processing outcome
Process Outcome Codes (Example)
. . . disposition 0..1 string Disposition Message
. . . requestProvider 0..1 Reference(Practitioner) Responsible Practitioner
. . . requestOrganization 0..1 Reference(Organization) Responsible organization
. . . form 0..1 CodeableConcept Printed Form Identifier
Form Codes (Example)
. . . processNote 0..* BackboneElement Processing comments or additional requirements
. . . . type 0..1 CodeableConcept display | print | printoper
NoteType (Required)
. . . . text 0..1 string Comment on the processing
. . . error 0..* CodeableConcept Error code
Adjudication Error Codes (Example)
. . . communicationRequest 0..* Reference(CommunicationRequest) Request for additional information

doco Documentation for this format
Name Flags Card. Type Description & Constraints doco
. . Provenance DomainResource Who, What, When for a set of resources
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
. . . target Σ 1..* Reference(Any) Target Reference(s) (usually version specific)
. . . period 0..1 Period When the activity occurred
. . . recorded Σ 1..1 instant When the activity was recorded / updated
. . . policy 0..* uri Policy or plan the activity was defined by
. . . location 0..1 Reference(Location) Where the activity occurred, if relevant
. . . reason 0..* Coding Reason the activity is occurring
PurposeOfUse (Extensible)
. . . activity 0..1 Coding Activity that occurred
ProvenanceActivityType (Extensible)
. . . agent 1..* BackboneElement Actor involved
. . . . role Σ 0..* CodeableConcept What the agents role was
SecurityRoleType (Extensible)
. . . . who[x] Σ 1..1 Who participated
. . . . . whoUri uri
. . . . . whoReference Reference(Practitioner | RelatedPerson | Patient | Device | Organization)
. . . . onBehalfOf[x] 0..1 Who the agent is representing
. . . . . onBehalfOfUri uri
. . . . . onBehalfOfReference Reference(Practitioner | RelatedPerson | Patient | Device | Organization)
. . . . relatedAgentType 0..1 CodeableConcept Type of relationship between agents
v3 Code System RoleLinkType (Example)
. . . entity 0..* BackboneElement An entity used in this activity
. . . . role Σ 1..1 code derivation | revision | quotation | source | removal
ProvenanceEntityRole (Required)
. . . . what[x] Σ 1..1 Identity of entity
. . . . . whatUri uri
. . . . . whatReference Reference(Any)
. . . . . whatIdentifier Identifier
. . . . agent 0..* see agent Entity is attributed to this agent
. . . signature 0..* Signature Signature on target

doco Documentation for this format
Name Flags Card. Type Description & Constraints doco
. . Questionnaire I DomainResource A structured set of questions
+ The link ids for groups and questions must be unique within the questionnaire
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
. . . url Σ 0..1 uri Logical URI to reference this questionnaire (globally unique)
. . . identifier Σ 0..* Identifier Additional identifier for the questionnaire
. . . version Σ 0..1 string Business version of the questionnaire
. . . name Σ 0..1 string Name for this questionnaire (computer friendly)
. . . title Σ 0..1 string Name for this questionnaire (human friendly)
. . . status ?! Σ 1..1 code draft | active | retired | unknown
PublicationStatus (Required)
. . . experimental ?! Σ 0..1 boolean For testing purposes, not real usage
. . . date Σ 0..1 dateTime Date this was last changed
. . . publisher Σ 0..1 string Name of the publisher (organization or individual)
. . . description 0..1 markdown Natural language description of the questionnaire
. . . purpose 0..1 markdown Why this questionnaire is defined
. . . approvalDate 0..1 date When the questionnaire was approved by publisher
. . . lastReviewDate 0..1 date When the questionnaire was last reviewed
. . . effectivePeriod Σ 0..1 Period When the questionnaire is expected to be used
. . . useContext Σ 0..* UsageContext Context the content is intended to support
. . . jurisdiction Σ 0..* CodeableConcept Intended jurisdiction for questionnaire (if applicable)
Jurisdiction ValueSet (Extensible)
. . . contact Σ 0..* ContactDetail Contact details for the publisher
. . . copyright 0..1 markdown Use and/or publishing restrictions
. . . code Σ 0..* Coding Concept that represents the overall questionnaire
Questionnaire Question Codes (Example)
. . . subjectType Σ 0..* code Resource that can be subject of QuestionnaireResponse
ResourceType (Required)
. . . item I 0..* BackboneElement Questions and sections within the Questionnaire
+ Read-only can't be specified for "display" items
+ Default values can't be specified for groups or display items
+ Required and repeat aren't permitted for display items
+ Only 'choice' items can have options
+ A question cannot have both option and options
+ Display items cannot have a "code" asserted
+ Maximum length can only be declared for simple question types
+ Group items must have nested items, display items cannot have nested items
. . . . linkId 1..1 string Unique id for item in questionnaire
. . . . definition 0..1 uri ElementDefinition - details for the item
. . . . code Σ I 0..* Coding Corresponding concept for this item in a terminology
Questionnaire Question Codes (Example)
. . . . prefix 0..1 string E.g. "1(a)", "2.5.3"
. . . . text Σ 0..1 string Primary text for the item
. . . . type 1..1 code group | display | boolean | decimal | integer | date | dateTime +
QuestionnaireItemType (Required)
. . . . enableWhen ?! Σ I 0..* BackboneElement Only allow data when
+ enableWhen must contain either a 'answer' or a 'hasAnswer' element
. . . . . question 1..1 string Question that determines whether item is enabled
. . . . . hasAnswer I 0..1 boolean Enable when answered or not
. . . . . answer[x] I 0..1 Value question must have
Questionnaire Answer Codes (Example)
. . . . . . answerBoolean boolean
. . . . . . answerDecimal decimal
. . . . . . answerInteger integer
. . . . . . answerDate date
. . . . . . answerDateTime dateTime
. . . . . . answerTime time
. . . . . . answerString string
. . . . . . answerUri uri
. . . . . . answerAttachment Attachment
. . . . . . answerCoding Coding
. . . . . . answerQuantity Quantity
. . . . . . answerReference Reference(Any)
. . . . required I 0..1 boolean Whether the item must be included in data results
. . . . repeats I 0..1 boolean Whether the item may repeat
. . . . readOnly I 0..1 boolean Don't allow human editing
. . . . maxLength I 0..1 integer No more than this many characters
. . . . options I 0..1 Reference(ValueSet) Valueset containing permitted answers
. . . . option I 0..* BackboneElement Permitted answer
. . . . . value[x] 1..1 Answer value
Questionnaire Answer Codes (Example)
. . . . . . valueInteger integer
. . . . . . valueDate date
. . . . . . valueTime time
. . . . . . valueString string
. . . . . . valueCoding Coding
. . . . initial[x] I 0..1 Default value when item is first rendered
Questionnaire Answer Codes (Example)
. . . . . initialBoolean boolean
. . . . . initialDecimal decimal
. . . . . initialInteger integer
. . . . . initialDate date
. . . . . initialDateTime dateTime
. . . . . initialTime time
. . . . . initialString string
. . . . . initialUri uri
. . . . . initialAttachment Attachment
. . . . . initialCoding Coding
. . . . . initialQuantity Quantity
. . . . . initialReference Reference(Any)
. . . . item I 0..* see item Nested questionnaire items

doco Documentation for this format
Name Flags Card. Type Description & Constraints doco
. . QuestionnaireResponse DomainResource A structured set of questions and their answers
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
. . . identifier Σ 0..1 Identifier Unique id for this set of answers
. . . basedOn Σ 0..* Reference(ReferralRequest | CarePlan | ProcedureRequest) Request fulfilled by this QuestionnaireResponse
. . . parent Σ 0..* Reference(Observation | Procedure) Part of this action
. . . questionnaire Σ 0..1 Reference(Questionnaire) Form being answered
. . . status ?! Σ 1..1 code in-progress | completed | amended | entered-in-error | stopped
QuestionnaireResponseStatus (Required)
. . . subject Σ 0..1 Reference(Any) The subject of the questions
. . . context Σ 0..1 Reference(Encounter | EpisodeOfCare) Encounter or Episode during which questionnaire was completed
. . . authored Σ 0..1 dateTime Date the answers were gathered
. . . author Σ 0..1 Reference(Device | Practitioner | Patient | RelatedPerson) Person who received and recorded the answers
. . . source Σ 0..1 Reference(Patient | Practitioner | RelatedPerson) The person who answered the questions
. . . item I 0..* BackboneElement Groups and questions
+ Nested item can't be beneath both item and answer
. . . . linkId 1..1 string Pointer to specific item from Questionnaire
. . . . definition 0..1 uri ElementDefinition - details for the item
. . . . text 0..1 string Name for group or question text
. . . . subject 0..1 Reference(Any) The subject this group's answers are about
. . . . answer 0..* BackboneElement The response(s) to the question
. . . . . value[x] 0..1 Single-valued answer to the question
Questionnaire Answer Codes (Example)
. . . . . . valueBoolean boolean
. . . . . . valueDecimal decimal
. . . . . . valueInteger integer
. . . . . . valueDate date
. . . . . . valueDateTime dateTime
. . . . . . valueTime time
. . . . . . valueString string
. . . . . . valueUri uri
. . . . . . valueAttachment Attachment
. . . . . . valueCoding Coding
. . . . . . valueQuantity Quantity
. . . . . . valueReference Reference(Any)
. . . . . item 0..* see item Nested groups and questions
. . . . item 0..* see item Nested questionnaire response items

doco Documentation for this format
Name Flags Card. Type Description & Constraints doco
. . ReferralRequest DomainResource A request for referral or transfer of care
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
. . . identifier Σ 0..* Identifier Business identifier
. . . definition Σ 0..* Reference(ActivityDefinition | PlanDefinition) Instantiates protocol or definition
. . . basedOn Σ 0..* Reference(ReferralRequest | CarePlan | ProcedureRequest) Request fulfilled by this request
. . . replaces Σ 0..* Reference(ReferralRequest) Request(s) replaced by this request
. . . groupIdentifier Σ 0..1 Identifier Composite request this is part of
. . . status ?! Σ 1..1 code draft | active | suspended | cancelled | completed | entered-in-error | unknown
RequestStatus (Required)
. . . intent ?! Σ 1..1 code proposal | plan | order
RequestIntent (Required)
. . . type Σ 0..1 CodeableConcept Referral/Transition of care request type
SNOMED CT Patient Referral (Example)
. . . priority Σ 0..1 code Urgency of referral / transfer of care request
RequestPriority (Required)
. . . serviceRequested Σ 0..* CodeableConcept Actions requested as part of the referral
Practice Setting Code Value Set (Example)
. . . subject Σ 1..1 Reference(Patient | Group) Patient referred to care or transfer
. . . context Σ 0..1 Reference(Encounter | EpisodeOfCare) Originating encounter
. . . occurrence[x] Σ 0..1 When the service(s) requested in the referral should occur
. . . . occurrenceDateTime dateTime
. . . . occurrencePeriod Period
. . . authoredOn Σ 0..1 dateTime Date of creation/activation
. . . requester Σ I 0..1 BackboneElement Who/what is requesting service
+ onBehalfOf can only be specified if agent is practitioner or device
. . . . agent Σ 1..1 Reference(Practitioner | Organization | Patient | RelatedPerson | Device) Individual making the request
. . . . onBehalfOf Σ I 0..1 Reference(Organization) Organization agent is acting for
. . . specialty 0..1 CodeableConcept The clinical specialty (discipline) that the referral is requested for
PractitionerSpecialty (Example)
. . . recipient Σ 0..* Reference(Practitioner | Organization | HealthcareService) Receiver of referral / transfer of care request
. . . reasonCode Σ 0..* CodeableConcept Reason for referral / transfer of care request
SNOMED CT Clinical Findings (Example)
. . . reasonReference Σ 0..* Reference(Condition | Observation) Why is service needed?
. . . description 0..1 string A textual description of the referral
. . . supportingInfo 0..* Reference(Any) Additonal information to support referral or transfer of care request
. . . note 0..* Annotation Comments made about referral request
. . . relevantHistory 0..* Reference(Provenance) Key events in history of request

doco Documentation for this format
Name Flags Card. Type Description & Constraints doco
. . RelatedPerson DomainResource An person that is related to a patient, but who is not a direct target of care
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
. . . identifier Σ 0..* Identifier A human identifier for this person
. . . active ?! Σ 0..1 boolean Whether this related person's record is in active use
. . . patient Σ 1..1 Reference(Patient) The patient this person is related to
. . . relationship Σ 0..1 CodeableConcept The nature of the relationship
PatientRelationshipType (Preferred)
. . . name Σ 0..* HumanName A name associated with the person
. . . telecom Σ 0..* ContactPoint A contact detail for the person
. . . gender Σ 0..1 code male | female | other | unknown
AdministrativeGender (Required)
. . . birthDate Σ 0..1 date The date on which the related person was born
. . . address Σ 0..* Address Address where the related person can be contacted or visited
. . . photo 0..* Attachment Image of the person
. . . period 0..1 Period Period of time that this relationship is considered valid

doco Documentation for this format
Name Flags Card. Type Description & Constraints doco
. . RequestGroup DomainResource A group of related requests
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
. . . identifier Σ 0..* Identifier Business identifier
. . . definition 0..* Reference(Any) Instantiates protocol or definition
. . . basedOn 0..* Reference(Any) Fulfills plan, proposal, or order
. . . replaces 0..* Reference(Any) Request(s) replaced by this request
. . . groupIdentifier Σ 0..1 Identifier Composite request this is part of
. . . status ?! Σ 1..1 code draft | active | suspended | cancelled | completed | entered-in-error | unknown
RequestStatus (Required)
. . . intent ?! Σ 1..1 code proposal | plan | order
RequestIntent (Required)
. . . priority Σ 0..1 code routine | urgent | asap | stat
RequestPriority (Required)
. . . subject 0..1 Reference(Patient | Group) Who the request group is about
. . . context 0..1 Reference(Encounter | EpisodeOfCare) Encounter or Episode for the request group
. . . authoredOn 0..1 dateTime When the request group was authored
. . . author 0..1 Reference(Device | Practitioner) Device or practitioner that authored the request group
. . . reason[x] 0..1 Reason for the request group
. . . . reasonCodeableConcept CodeableConcept
. . . . reasonReference Reference(Any)
. . . note 0..* Annotation Additional notes about the response
. . . action I 0..* BackboneElement Proposed actions, if any
+ Must have resource or action but not both
. . . . label 0..1 string User-visible label for the action (e.g. 1. or A.)
. . . . title 0..1 string User-visible title
. . . . description Σ 0..1 string Short description of the action
. . . . textEquivalent Σ 0..1 string Static text equivalent of the action, used if the dynamic aspects cannot be interpreted by the receiving system
. . . . code 0..* CodeableConcept Code representing the meaning of the action or sub-actions
. . . . documentation 0..* RelatedArtifact Supporting documentation for the intended performer of the action
. . . . condition 0..* BackboneElement Whether or not the action is applicable
. . . . . kind 1..1 code applicability | start | stop
ActionConditionKind (Required)
. . . . . description 0..1 string Natural language description of the condition
. . . . . language 0..1 string Language of the expression
. . . . . expression 0..1 string Boolean-valued expression
. . . . relatedAction 0..* BackboneElement Relationship to another action
. . . . . actionId 1..1 id What action this is related to
. . . . . relationship 1..1 code before-start | before | before-end | concurrent-with-start | concurrent | concurrent-with-end | after-start | after | after-end
ActionRelationshipType (Required)
. . . . . offset[x] 0..1 Time offset for the relationship
. . . . . . offsetDuration Duration
. . . . . . offsetRange Range
. . . . timing[x] 0..1 When the action should take place
. . . . . timingDateTime dateTime
. . . . . timingPeriod Period
. . . . . timingDuration Duration
. . . . . timingRange Range
. . . . . timingTiming Timing
. . . . participant 0..* Reference(Patient | Person | Practitioner | RelatedPerson) Who should perform the action
. . . . type 0..1 Coding create | update | remove | fire-event
ActionType (Extensible)
. . . . groupingBehavior 0..1 code visual-group | logical-group | sentence-group
ActionGroupingBehavior (Required)
. . . . selectionBehavior 0..1 code any | all | all-or-none | exactly-one | at-most-one | one-or-more
ActionSelectionBehavior (Required)
. . . . requiredBehavior 0..1 code must | could | must-unless-documented
ActionRequiredBehavior (Required)
. . . . precheckBehavior 0..1 code yes | no
ActionPrecheckBehavior (Required)
. . . . cardinalityBehavior 0..1 code single | multiple
ActionCardinalityBehavior (Required)
. . . . resource I 0..1 Reference(Any) The target of the action
. . . . action I 0..* see action Sub action

doco Documentation for this format
Name Flags Card. Type Description & Constraints doco
. . ResearchStudy DomainResource Investigation to increase healthcare-related patient-independent knowledge
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
. . . identifier Σ 0..* Identifier Business Identifier for study
. . . title Σ 0..1 string Name for this study
. . . protocol Σ 0..* Reference(PlanDefinition) Steps followed in executing study
. . . partOf Σ 0..* Reference(ResearchStudy) Part of larger study
. . . status ?! Σ 1..1 code draft | in-progress | suspended | stopped | completed | entered-in-error
ResearchStudyStatus (Required)
. . . category Σ 0..* CodeableConcept Classifications for the study
. . . focus Σ 0..* CodeableConcept Drugs, devices, conditions, etc. under study
. . . contact Σ 0..* ContactDetail Contact details for the study
. . . relatedArtifact 0..* RelatedArtifact References and dependencies
. . . keyword Σ 0..* CodeableConcept Used to search for the study
. . . jurisdiction Σ 0..* CodeableConcept Geographic region(s) for study
Jurisdiction ValueSet (Extensible)
. . . description 0..1 markdown What this is study doing
. . . enrollment Σ 0..* Reference(Group) Inclusion & exclusion criteria
. . . period Σ 0..1 Period When the study began and ended
. . . sponsor Σ 0..1 Reference(Organization) Organization responsible for the study
. . . principalInvestigator Σ 0..1 Reference(Practitioner) The individual responsible for the study
. . . site Σ 0..* Reference(Location) Location involved in study execution
. . . reasonStopped Σ 0..1 CodeableConcept Reason for terminating study early
. . . note 0..* Annotation Comments made about the event
. . . arm 0..* BackboneElement Defined path through the study for a subject
. . . . name 1..1 string Label for study arm
. . . . code 0..1 CodeableConcept Categorization of study arm
. . . . description 0..1 string Short explanation of study path

doco Documentation for this format
Name Flags Card. Type Description & Constraints doco
. . ResearchSubject DomainResource Investigation to increase healthcare-related patient-independent knowledge
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
. . . identifier Σ 0..1 Identifier Business Identifier for research subject
. . . status ?! Σ 1..1 code candidate | enrolled | active | suspended | withdrawn | completed
ResearchSubjectStatus (Required)
. . . period Σ 0..1 Period Start and end of participation
. . . study Σ 1..1 Reference(ResearchStudy) Study subject is part of
. . . individual Σ 1..1 Reference(Patient) Who is part of study
. . . assignedArm 0..1 string What path should be followed
. . . actualArm 0..1 string What path was followed
. . . consent 0..1 Reference(Consent) Agreement to participate in study

doco Documentation for this format
Name Flags Card. Type Description & Constraints doco
. . RiskAssessment DomainResource Potential outcomes for a subject with likelihood
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
. . . identifier Σ 0..1 Identifier Unique identifier for the assessment
. . . basedOn 0..1 Reference(Any) Request fulfilled by this assessment
. . . parent 0..1 Reference(Any) Part of this occurrence
. . . status 1..1 code registered | preliminary | final | amended +
ObservationStatus (Required)
. . . method Σ 0..1 CodeableConcept Evaluation mechanism
. . . code Σ 0..1 CodeableConcept Type of assessment
. . . subject Σ 0..1 Reference(Patient | Group) Who/what does assessment apply to?
. . . context Σ 0..1 Reference(Encounter | EpisodeOfCare) Where was assessment performed?
. . . occurrence[x] Σ 0..1 When was assessment made?
. . . . occurrenceDateTime dateTime
. . . . occurrencePeriod Period
. . . condition Σ 0..1 Reference(Condition) Condition assessed
. . . performer Σ 0..1 Reference(Practitioner | Device) Who did assessment?
. . . reason[x] 0..1 Why the assessment was necessary?
. . . . reasonCodeableConcept CodeableConcept
. . . . reasonReference Reference(Any)
. . . basis 0..* Reference(Any) Information used in assessment
. . . prediction I 0..* BackboneElement Outcome predicted
+ Must be <= 100
. . . . outcome 1..1 CodeableConcept Possible outcome for the subject
. . . . probability[x] I 0..1 Likelihood of specified outcome
+ low and high must be percentages, if present
. . . . . probabilityDecimal decimal
. . . . . probabilityRange Range
. . . . qualitativeRisk 0..1 CodeableConcept Likelihood of specified outcome as a qualitative value
Risk Probability (Example)
. . . . relativeRisk 0..1 decimal Relative likelihood
. . . . when[x] 0..1 Timeframe or age range
. . . . . whenPeriod Period
. . . . . whenRange Range
. . . . rationale 0..1 string Explanation of prediction
. . . mitigation 0..1 string How to reduce risk
. . . comment 0..1 string Comments on the risk assessment

doco Documentation for this format
Name Flags Card. Type Description & Constraints doco
. . Schedule DomainResource A container for slots of time that may be available for booking appointments
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
. . . identifier Σ 0..* Identifier External Ids for this item
. . . active ?! Σ 0..1 boolean Whether this schedule is in active use
. . . serviceCategory Σ 0..1 CodeableConcept A broad categorisation of the service that is to be performed during this appointment
ServiceCategory (Example)
. . . serviceType Σ 0..* CodeableConcept The specific service that is to be performed during this appointment
ServiceType (Example)
. . . specialty Σ 0..* CodeableConcept The specialty of a practitioner that would be required to perform the service requested in this appointment
Practice Setting Code Value Set (Preferred)
. . . actor Σ 1..* Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Device | HealthcareService | Location) The resource this Schedule resource is providing availability information for. These are expected to usually be one of HealthcareService, Location, Practitioner, PractitionerRole, Device, Patient or RelatedPerson
. . . planningHorizon Σ 0..1 Period The period of time that the slots that are attached to this Schedule resource cover (even if none exist). These cover the amount of time that an organization's planning horizon; the interval for which they are currently accepting appointments. This does not define a "template" for planning outside these dates
. . . comment 0..1 string Comments on the availability to describe any extended information. Such as custom constraints on the slots that may be associated

doco Documentation for this format
Name Flags Card. Type Description & Constraints doco
. . SearchParameter I DomainResource Search Parameter for a resource
+ If an xpath is present, there SHALL be an xpathUsage
+ Search parameters can only have chain names when the search parameter type is 'reference'
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
. . . url Σ 1..1 uri Logical URI to reference this search parameter (globally unique)
. . . version Σ 0..1 string Business version of the search parameter
. . . name Σ 1..1 string Name for this search parameter (computer friendly)
. . . status ?! Σ 1..1 code draft | active | retired | unknown
PublicationStatus (Required)
. . . experimental ?! Σ 0..1 boolean For testing purposes, not real usage
. . . date Σ 0..1 dateTime Date this was last changed
. . . publisher Σ 0..1 string Name of the publisher (organization or individual)
. . . contact Σ 0..* ContactDetail Contact details for the publisher
. . . useContext Σ 0..* UsageContext Context the content is intended to support
. . . jurisdiction Σ 0..* CodeableConcept Intended jurisdiction for search parameter (if applicable)
Jurisdiction ValueSet (Extensible)
. . . purpose 0..1 markdown Why this search parameter is defined
. . . code Σ 1..1 code Code used in URL
. . . base Σ 1..* code The resource type(s) this search parameter applies to
ResourceType (Required)
. . . type Σ 1..1 code number | date | string | token | reference | composite | quantity | uri
SearchParamType (Required)
. . . derivedFrom 0..1 uri Original Definition for the search parameter
. . . description Σ 1..1 markdown Natural language description of the search parameter
. . . expression I 0..1 string FHIRPath expression that extracts the values
. . . xpath I 0..1 string XPath that extracts the values
. . . xpathUsage I 0..1 code normal | phonetic | nearby | distance | other
XPathUsageType (Required)
. . . target 0..* code Types of resource (if a resource reference)
ResourceType (Required)
. . . comparator 0..* code eq | ne | gt | lt | ge | le | sa | eb | ap
SearchComparator (Required)
. . . modifier 0..* code missing | exact | contains | not | text | in | not-in | below | above | type
SearchModifierCode (Required)
. . . chain 0..* string Chained names supported
. . . component 0..* BackboneElement For Composite resources to define the parts
. . . . definition 1..1 Reference(SearchParameter) Defines how the part works
. . . . expression 1..1 string Subexpression relative to main expression

doco Documentation for this format
Name Flags Card. Type Description & Constraints doco
. . Sequence Σ I DomainResource Information about a biological sequence
+ Only 0 and 1 are valid for coordinateSystem
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
. . . identifier Σ 0..* Identifier Unique ID for this particular sequence. This is a FHIR-defined id
. . . type Σ 0..1 code aa | dna | rna
sequenceType (Example)
. . . coordinateSystem Σ 1..1 integer Base number of coordinate system (0 for 0-based numbering or coordinates, inclusive start, exclusive end, 1 for 1-based numbering, inclusive start, inclusive end)
. . . patient Σ 0..1 Reference(Patient) Who and/or what this is about
. . . specimen Σ 0..1 Reference(Specimen) Specimen used for sequencing
. . . device Σ 0..1 Reference(Device) The method for sequencing
. . . performer Σ 0..1 Reference(Organization) Who should be responsible for test result
. . . quantity Σ 0..1 Quantity The number of copies of the seqeunce of interest. (RNASeq)
. . . referenceSeq Σ I 0..1 BackboneElement A sequence used as reference
+ Only +1 and -1 are valid for strand
+ GenomeBuild and chromosome must be both contained if either one of them is contained
+ Have and only have one of the following elements in referenceSeq : 1. genomeBuild ; 2 referenceSeqId; 3. referenceSeqPointer; 4. referenceSeqString;
. . . . chromosome Σ 0..1 CodeableConcept Chromosome containing genetic finding
chromosome-human (Example)
. . . . genomeBuild Σ 0..1 string The Genome Build used for reference, following GRCh build versions e.g. 'GRCh 37'
. . . . referenceSeqId Σ 0..1 CodeableConcept Reference identifier
ENSEMBL (Example)
. . . . referenceSeqPointer Σ 0..1 Reference(Sequence) A Pointer to another Sequence entity as reference sequence
. . . . referenceSeqString Σ 0..1 string A string to represent reference sequence
. . . . strand Σ 0..1 integer Directionality of DNA ( +1/-1)
. . . . windowStart Σ 1..1 integer Start position of the window on the reference sequence
. . . . windowEnd Σ 1..1 integer End position of the window on the reference sequence
. . . variant Σ 0..* BackboneElement Variant in sequence
. . . . start Σ 0..1 integer Start position of the variant on the reference sequence
. . . . end Σ 0..1 integer End position of the variant on the reference sequence
. . . . observedAllele Σ 0..1 string Allele that was observed
. . . . referenceAllele Σ 0..1 string Allele in the reference sequence
. . . . cigar Σ 0..1 string Extended CIGAR string for aligning the sequence with reference bases
. . . . variantPointer Σ 0..1 Reference(Observation) Pointer to observed variant information
. . . observedSeq Σ 0..1 string Sequence that was observed
. . . quality Σ 0..* BackboneElement An set of value as quality of sequence
. . . . type Σ 1..1 code indel | snp | unknown
qualityType (Required)
. . . . standardSequence Σ 0..1 CodeableConcept Standard sequence for comparison
FDA-StandardSequence (Example)
. . . . start Σ 0..1 integer Start position of the sequence
. . . . end Σ 0..1 integer End position of the sequence
. . . . score Σ 0..1 Quantity Quality score for the comparison
. . . . method Σ 0..1 CodeableConcept Method to get quality
FDA-Method (Example)
. . . . truthTP Σ 0..1 decimal True positives from the perspective of the truth data
. . . . queryTP Σ 0..1 decimal True positives from the perspective of the query data
. . . . truthFN Σ 0..1 decimal False negatives
. . . . queryFP Σ 0..1 decimal False positives
. . . . gtFP Σ 0..1 decimal False positives where the non-REF alleles in the Truth and Query Call Sets match
. . . . precision Σ 0..1 decimal Precision of comparison
. . . . recall Σ 0..1 decimal Recall of comparison
. . . . fScore Σ 0..1 decimal F-score
. . . readCoverage Σ 0..1 integer Average number of reads representing a given nucleotide in the reconstructed sequence
. . . repository Σ 0..* BackboneElement External repository which contains detailed report related with observedSeq in this resource
. . . . type Σ 1..1 code directlink | openapi | login | oauth | other
repositoryType (Required)
. . . . url Σ 0..1 uri URI of the repository
. . . . name Σ 0..1 string Repository's name
. . . . datasetId Σ 0..1 string Id of the dataset that used to call for dataset in repository
. . . . variantsetId Σ 0..1 string Id of the variantset that used to call for variantset in repository
. . . . readsetId Σ 0..1 string Id of the read
. . . pointer Σ 0..* Reference(Sequence) Pointer to next atomic sequence

doco Documentation for this format
Name Flags Card. Type Description & Constraints doco
. . ServiceDefinition DomainResource A description of decision support service functionality
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
. . . url Σ 0..1 uri Logical URI to reference this service definition (globally unique)
. . . identifier Σ 0..* Identifier Additional identifier for the service definition
. . . version Σ 0..1 string Business version of the service definition
. . . name Σ 0..1 string Name for this service definition (computer friendly)
. . . title Σ 0..1 string Name for this service definition (human friendly)
. . . status ?! Σ 1..1 code draft | active | retired | unknown
PublicationStatus (Required)
. . . experimental ?! Σ 0..1 boolean For testing purposes, not real usage
. . . date Σ 0..1 dateTime Date this was last changed
. . . publisher Σ 0..1 string Name of the publisher (organization or individual)
. . . description 0..1 markdown Natural language description of the service definition
. . . purpose 0..1 markdown Why this service definition is defined
. . . usage 0..1 string Describes the clinical usage of the module
. . . approvalDate 0..1 date When the service definition was approved by publisher
. . . lastReviewDate 0..1 date When the service definition was last reviewed
. . . effectivePeriod Σ 0..1 Period When the service definition is expected to be used
. . . useContext Σ 0..* UsageContext Context the content is intended to support
. . . jurisdiction Σ 0..* CodeableConcept Intended jurisdiction for service definition (if applicable)
Jurisdiction ValueSet (Extensible)
. . . topic 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc
DefinitionTopic (Example)
. . . contributor 0..* Contributor A content contributor
. . . contact Σ 0..* ContactDetail Contact details for the publisher
. . . copyright 0..1 markdown Use and/or publishing restrictions
. . . relatedArtifact 0..* RelatedArtifact Additional documentation, citations, etc
. . . trigger 0..* TriggerDefinition "when" the module should be invoked
. . . dataRequirement 0..* DataRequirement What data is used by the module
. . . operationDefinition 0..1 Reference(OperationDefinition) Operation to invoke

doco Documentation for this format
Name Flags Card. Type Description & Constraints doco
. . Slot DomainResource A slot of time on a schedule that may be available for booking appointments
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
. . . identifier Σ 0..* Identifier External Ids for this item
. . . serviceCategory Σ 0..1 CodeableConcept A broad categorisation of the service that is to be performed during this appointment
ServiceCategory (Example)
. . . serviceType Σ 0..* CodeableConcept The type of appointments that can be booked into this slot (ideally this would be an identifiable service - which is at a location, rather than the location itself). If provided then this overrides the value provided on the availability resource
ServiceType (Example)
. . . specialty Σ 0..* CodeableConcept The specialty of a practitioner that would be required to perform the service requested in this appointment
Practice Setting Code Value Set (Preferred)
. . . appointmentType Σ 0..1 CodeableConcept The style of appointment or patient that may be booked in the slot (not service type)
v2 Appointment reason codes (Preferred)
. . . schedule Σ 1..1 Reference(Schedule) The schedule resource that this slot defines an interval of status information
. . . status Σ 1..1 code busy | free | busy-unavailable | busy-tentative | entered-in-error
SlotStatus (Required)
. . . start Σ 1..1 instant Date/Time that the slot is to begin
. . . end Σ 1..1 instant Date/Time that the slot is to conclude
. . . overbooked 0..1 boolean This slot has already been overbooked, appointments are unlikely to be accepted for this time
. . . comment 0..1 string Comments on the slot to describe any extended information. Such as custom constraints on the slot

doco Documentation for this format
Name Flags Card. Type Description & Constraints doco
. . Specimen DomainResource Sample for analysis
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
. . . identifier Σ 0..* Identifier External Identifier
. . . accessionIdentifier Σ 0..1 Identifier Identifier assigned by the lab
. . . status ?! Σ 0..1 code available | unavailable | unsatisfactory | entered-in-error
SpecimenStatus (Required)
. . . type Σ 0..1 CodeableConcept Kind of material that forms the specimen
v2 Specimen Type (Example)
. . . subject Σ 1..1 Reference(Patient | Group | Device | Substance) Where the specimen came from. This may be from the patient(s) or from the environment or a device
. . . receivedTime Σ 0..1 dateTime The time when specimen was received for processing
. . . parent 0..* Reference(Specimen) Specimen from which this specimen originated
. . . request 0..* Reference(ProcedureRequest) Why the specimen was collected
. . . collection 0..1 BackboneElement Collection details
. . . . collector Σ 0..1 Reference(Practitioner) Who collected the specimen
. . . . collected[x] Σ 0..1 Collection time
. . . . . collectedDateTime dateTime
. . . . . collectedPeriod Period
. . . . quantity 0..1 SimpleQuantity The quantity of specimen collected
. . . . method 0..1 CodeableConcept Technique used to perform collection
FHIR Specimen Collection Method (Example)
. . . . bodySite 0..1 CodeableConcept Anatomical collection site
SNOMED CT Body Structures (Example)
. . . processing 0..* BackboneElement Processing and processing step details
. . . . description 0..1 string Textual description of procedure
. . . . procedure 0..1 CodeableConcept Indicates the treatment step applied to the specimen
SpecimenProcessingProcedure (Example)
. . . . additive 0..* Reference(Substance) Material used in the processing step
. . . . time[x] 0..1 Date and time of specimen processing
. . . . . timeDateTime dateTime
. . . . . timePeriod Period
. . . container 0..* BackboneElement Direct container of specimen (tube/slide, etc.)
. . . . identifier Σ 0..* Identifier Id for the container
. . . . description 0..1 string Textual description of the container
. . . . type 0..1 CodeableConcept Kind of container directly associated with specimen
SpecimenContainer (Example)
. . . . capacity 0..1 SimpleQuantity Container volume or size
. . . . specimenQuantity 0..1 SimpleQuantity Quantity of specimen within container
. . . . additive[x] 0..1 Additive associated with container
v2 Additive/Preservative (Example)
. . . . . additiveCodeableConcept CodeableConcept
. . . . . additiveReference Reference(Substance)
. . . note 0..* Annotation Comments

doco Documentation for this format
Name Flags Card. Type Description & Constraints doco
. . StructureDefinition I DomainResource Structural Definition
+ In any snapshot or differential, no label, code or requirements on the an element without a "." in the path (e.g. the first element)
+ Custom types can only be used in logical models
+ All element definitions must have unique ids (snapshot)
+ Context Invariants can only be used for extensions
+ All element definitions must have unique ids (diff)
+ element.base cannot appear if there is no base on the structure definition
+ If there's a type, its content must match the path name in the first element of a snapshot
+ All element definitions must have an id
+ Element paths must be unique unless the structure is a constraint
+ If the structure describes a base Resource or Type, the URL has to start with "http://hl7.org/fhir/StructureDefinition/" and the tail must match the id
+ A structure must have either a differential, or a snapshot (or both)
+ If the structure defines an extension then the structure must have context information
+ If the structure is not abstract, then there SHALL be a baseDefinition
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
. . . url Σ 1..1 uri Logical URI to reference this structure definition (globally unique)
. . . identifier Σ 0..* Identifier Additional identifier for the structure definition
. . . version Σ 0..1 string Business version of the structure definition
. . . name Σ 1..1 string Name for this structure definition (computer friendly)
. . . title Σ 0..1 string Name for this structure definition (human friendly)
. . . status ?! Σ 1..1 code draft | active | retired | unknown
PublicationStatus (Required)
. . . experimental ?! Σ 0..1 boolean For testing purposes, not real usage
. . . date Σ 0..1 dateTime Date this was last changed
. . . publisher Σ 0..1 string Name of the publisher (organization or individual)
. . . contact Σ 0..* ContactDetail Contact details for the publisher
. . . description 0..1 markdown Natural language description of the structure definition
. . . useContext Σ 0..* UsageContext Context the content is intended to support
. . . jurisdiction Σ 0..* CodeableConcept Intended jurisdiction for structure definition (if applicable)
Jurisdiction ValueSet (Extensible)
. . . purpose 0..1 markdown Why this structure definition is defined
. . . copyright 0..1 markdown Use and/or publishing restrictions
. . . keyword Σ 0..* Coding Assist with indexing and finding
Structure Definition Codes (Example)
. . . fhirVersion Σ 0..1 id FHIR Version this StructureDefinition targets
. . . mapping I 0..* BackboneElement External specification that the content is mapped to
+ Must have at least a name or a uri (or both)
. . . . identity 1..1 id Internal id when this mapping is used
. . . . uri I 0..1 uri Identifies what this mapping refers to
. . . . name I 0..1 string Names what this mapping refers to
. . . . comment 0..1 string Versions, Issues, Scope limitations etc.
. . . kind Σ 1..1 code primitive-type | complex-type | resource | logical
StructureDefinitionKind (Required)
. . . abstract Σ 1..1 boolean Whether the structure is abstract
. . . contextType Σ I 0..1 code resource | datatype | extension
ExtensionContext (Required)
. . . context Σ I 0..* string Where the extension can be used in instances
. . . contextInvariant Σ I 0..* string FHIRPath invariants - when the extension can be used
. . . type Σ I 1..1 code Type defined or constrained by this structure
FHIRDefinedType (Extensible)
. . . baseDefinition Σ I 0..1 uri Definition that this type is constrained/specialized from
. . . derivation Σ I 0..1 code specialization | constraint - How relates to base definition
TypeDerivationRule (Required)
. . . snapshot I 0..1 BackboneElement Snapshot view of the structure
+ The first element in a snapshot has no type
+ In any snapshot, all the elements must be in the specified type
+ Each element definition in a snapshot must have a formal definition and cardinalities
. . . . element I 1..* ElementDefinition Definition of elements in the resource (if no StructureDefinition)
. . . differential I 0..1 BackboneElement Differential view of the structure
+ If the first element in a differential has no "." in the path, it has no type
+ No slicing on the root element
+ In any differential, all the elements must be in the specified type
. . . . element 1..* ElementDefinition Definition of elements in the resource (if no StructureDefinition)

doco Documentation for this format
Name Flags Card. Type Description & Constraints doco
. . StructureMap DomainResource A Map of relationships between 2 structures that can be used to transform data
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
. . . url Σ 1..1 uri Logical URI to reference this structure map (globally unique)
. . . identifier Σ 0..* Identifier Additional identifier for the structure map
. . . version Σ 0..1 string Business version of the structure map
. . . name Σ 1..1 string Name for this structure map (computer friendly)
. . . title Σ 0..1 string Name for this structure map (human friendly)
. . . status ?! Σ 1..1 code draft | active | retired | unknown
PublicationStatus (Required)
. . . experimental ?! Σ 0..1 boolean For testing purposes, not real usage
. . . date Σ 0..1 dateTime Date this was last changed
. . . publisher Σ 0..1 string Name of the publisher (organization or individual)
. . . contact Σ 0..* ContactDetail Contact details for the publisher
. . . description 0..1 markdown Natural language description of the structure map
. . . useContext Σ 0..* UsageContext Context the content is intended to support
. . . jurisdiction Σ 0..* CodeableConcept Intended jurisdiction for structure map (if applicable)
Jurisdiction ValueSet (Extensible)
. . . purpose 0..1 markdown Why this structure map is defined
. . . copyright 0..1 markdown Use and/or publishing restrictions
. . . structure Σ 0..* BackboneElement Structure Definition used by this map
. . . . url Σ 1..1 uri Canonical URL for structure definition
. . . . mode Σ 1..1 code source | queried | target | produced
StructureMapModelMode (Required)
. . . . alias Σ 0..1 string Name for type in this map
. . . . documentation 0..1 string Documentation on use of structure
. . . import Σ 0..* uri Other maps used by this map (canonical URLs)
. . . group Σ 1..* BackboneElement Named sections for reader convenience
. . . . name Σ 1..1 id Human-readable label
. . . . extends Σ 0..1 id Another group that this group adds rules to
. . . . typeMode Σ 1..1 code none | types | type-and-types
StructureMapGroupTypeMode (Required)
. . . . documentation Σ 0..1 string Additional description/explaination for group
. . . . input Σ 1..* BackboneElement Named instance provided when invoking the map
. . . . . name Σ 1..1 id Name for this instance of data
. . . . . type Σ 0..1 string Type for this instance of data
. . . . . mode Σ 1..1 code source | target
StructureMapInputMode (Required)
. . . . . documentation 0..1 string Documentation for this instance of data
. . . . rule Σ 1..* BackboneElement Transform Rule from source to target
. . . . . name Σ 1..1 id Name of the rule for internal references
. . . . . source Σ 1..* BackboneElement Source inputs to the mapping
. . . . . . context Σ 1..1 id Type or variable this rule applies to
. . . . . . min Σ 0..1 integer Specified minimum cardinality
. . . . . . max Σ 0..1 string Specified maximum cardinality (number or *)
. . . . . . type Σ 0..1 string Rule only applies if source has this type
. . . . . . defaultValue[x] Σ 0..1 * Default value if no value exists
. . . . . . element Σ 0..1 string Optional field for this source
. . . . . . listMode Σ 0..1 code first | not_first | last | not_last | only_one
StructureMapSourceListMode (Required)
. . . . . . variable Σ 0..1 id Named context for field, if a field is specified
. . . . . . condition Σ 0..1 string FHIRPath expression - must be true or the rule does not apply
. . . . . . check Σ 0..1 string FHIRPath expression - must be true or the mapping engine throws an error instead of completing
. . . . . target Σ I 0..* BackboneElement Content to create because of this mapping rule
+ Must have a contextType if you have a context
+ Can only have a element if you have a context
. . . . . . context Σ 0..1 id Type or variable this rule applies to
. . . . . . contextType Σ 0..1 code type | variable
StructureMapContextType (Required)
. . . . . . element Σ 0..1 string Field to create in the context
. . . . . . variable Σ 0..1 id Named context for field, if desired, and a field is specified
. . . . . . listMode Σ 0..* code first | share | last | collate
StructureMapTargetListMode (Required)
. . . . . . listRuleId Σ 0..1 id Internal rule reference for shared list items
. . . . . . transform Σ 0..1 code create | copy +
StructureMapTransform (Required)
. . . . . . parameter Σ 0..* BackboneElement Parameters to the transform
. . . . . . . value[x] Σ 1..1 Parameter value - variable or literal
. . . . . . . . valueId id
. . . . . . . . valueString string
. . . . . . . . valueBoolean boolean
. . . . . . . . valueInteger integer
. . . . . . . . valueDecimal decimal
. . . . . rule Σ 0..* see rule Rules contained in this rule
. . . . . dependent Σ 0..* BackboneElement Which other rules to apply in the context of this rule
. . . . . . name Σ 1..1 id Name of a rule or group to apply
. . . . . . variable Σ 1..* string Variable to pass to the rule or group
. . . . . documentation 0..1 string Documentation for this instance of data

doco Documentation for this format
Name Flags Card. Type Description & Constraints doco
. . Subscription Σ DomainResource A server push subscription criteria
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
. . . status ?! Σ 1..1 code requested | active | error | off
SubscriptionStatus (Required)
. . . contact Σ 0..* ContactPoint Contact details for source (e.g. troubleshooting)
. . . end Σ 0..1 instant When to automatically delete the subscription
. . . reason Σ 1..1 string Description of why this subscription was created
. . . criteria Σ 1..1 string Rule for server push criteria
. . . error Σ 0..1 string Latest error note
. . . channel Σ 1..1 BackboneElement The channel on which to report matches to the criteria
. . . . type Σ 1..1 code rest-hook | websocket | email | sms | message
SubscriptionChannelType (Required)
. . . . endpoint Σ 0..1 uri Where the channel points to
. . . . payload Σ 0..1 string Mimetype to send, or omit for no payload
. . . . header Σ 0..* string Usage depends on the channel type
. . . tag Σ 0..* Coding A tag to add to matching resources
SubscriptionTag (Example)

doco Documentation for this format
Name Flags Card. Type Description & Constraints doco
. . Substance DomainResource A homogeneous material with a definite composition
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
. . . identifier Σ 0..* Identifier Unique identifier
. . . status Σ 0..1 code active | inactive | entered-in-error
FHIRSubstanceStatus (Required)
. . . category Σ 0..* CodeableConcept What class/type of substance this is
Substance Category Codes (Extensible)
. . . code Σ 1..1 CodeableConcept What substance this is
Substance Code (Example)
. . . description Σ 0..1 string Textual description of the substance, comments
. . . instance Σ 0..* BackboneElement If this describes a specific package/container of the substance
. . . . identifier Σ 0..1 Identifier Identifier of the package/container
. . . . expiry Σ 0..1 dateTime When no longer valid to use
. . . . quantity Σ 0..1 SimpleQuantity Amount of substance in the package
. . . ingredient Σ 0..* BackboneElement Composition information about the substance
. . . . quantity Σ 0..1 Ratio Optional amount (concentration)
. . . . substance[x] Σ 1..1 A component of the substance
Substance Code (Example)
. . . . . substanceCodeableConcept CodeableConcept
. . . . . substanceReference Reference(Substance)

doco Documentation for this format
Name Flags Card. Type Description & Constraints doco
. . SupplyDelivery DomainResource Delivery of bulk Supplies
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
. . . identifier 0..1 Identifier External identifier
. . . basedOn Σ 0..* Reference(SupplyRequest) Fulfills plan, proposal or order
. . . partOf Σ 0..* Reference(SupplyDelivery | Contract) Part of referenced event
. . . status ?! Σ 0..1 code in-progress | completed | abandoned | entered-in-error
SupplyDeliveryStatus (Required)
. . . patient 0..1 Reference(Patient) Patient for whom the item is supplied
. . . type 0..1 CodeableConcept Category of dispense event
Supply Item Type (Required)
. . . suppliedItem 0..1 BackboneElement The item that is delivered or supplied
. . . . quantity 0..1 SimpleQuantity Amount dispensed
. . . . item[x] 0..1 Medication, Substance, or Device supplied
SNOMED CT Supply Item (Example)
. . . . . itemCodeableConcept CodeableConcept
. . . . . itemReference Reference(Medication | Substance | Device)
. . . occurrence[x] Σ 0..1 When event occurred
. . . . occurrenceDateTime dateTime
. . . . occurrencePeriod Period
. . . . occurrenceTiming Timing
. . . supplier 0..1 Reference(Practitioner | Organization) Dispenser
. . . destination 0..1 Reference(Location) Where the Supply was sent
. . . receiver 0..* Reference(Practitioner) Who collected the Supply

doco Documentation for this format
Name Flags Card. Type Description & Constraints doco
. . SupplyRequest DomainResource Request for a medication, substance or device
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
. . . identifier Σ 0..1 Identifier Unique identifier
. . . status ?! Σ 0..1 code draft | active | suspended +
SupplyRequestStatus (Required)
. . . category Σ 0..1 CodeableConcept The kind of supply (central, non-stock, etc.)
Supply Type (Example)
. . . priority Σ 0..1 code routine | urgent | asap | stat
RequestPriority (Required)
. . . orderedItem Σ 0..1 BackboneElement The item being requested
. . . . quantity Σ 1..1 Quantity The requested amount of the item indicated
. . . . item[x] Σ 0..1 Medication, Substance, or Device requested to be supplied
SNOMED CT Supply Item (Example)
. . . . . itemCodeableConcept CodeableConcept
. . . . . itemReference Reference(Medication | Substance | Device)
. . . occurrence[x] Σ 0..1 When the request should be fulfilled
. . . . occurrenceDateTime dateTime
. . . . occurrencePeriod Period
. . . . occurrenceTiming Timing
. . . authoredOn Σ 0..1 dateTime When the request was made
. . . requester Σ 0..1 BackboneElement Who/what is requesting service
. . . . agent Σ 1..1 Reference(Practitioner | Organization | Patient | RelatedPerson | Device) Individual making the request
. . . . onBehalfOf 0..1 Reference(Organization) Organization agent is acting for
. . . supplier Σ 0..* Reference(Organization) Who is intended to fulfill the request
. . . reason[x] 0..1 Why the supply item was requested
SupplyRequestReason (Example)
. . . . reasonCodeableConcept CodeableConcept
. . . . reasonReference Reference(Any)
. . . deliverFrom 0..1 Reference(Organization | Location) The origin of the supply
. . . deliverTo 0..1 Reference(Organization | Location | Patient) The destination of the supply

doco Documentation for this format
Name Flags Card. Type Description & Constraints doco
. . Task I DomainResource A task to be performed
+ Last modified date must be greater than or equal to authored-on date.
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
. . . identifier 0..* Identifier Task Instance Identifier
. . . definition[x] Σ 0..1 Formal definition of task
. . . . definitionUri uri
. . . . definitionReference Reference(ActivityDefinition)
. . . basedOn Σ 0..* Reference(Any) Request fulfilled by this task
. . . groupIdentifier Σ 0..1 Identifier Requisition or grouper id
. . . partOf Σ 0..* Reference(Task) Composite task
. . . status Σ 1..1 code draft | requested | received | accepted | +
TaskStatus (Required)
. . . statusReason Σ 0..1 CodeableConcept Reason for current status
. . . businessStatus Σ 0..1 CodeableConcept E.g. "Specimen collected", "IV prepped"
. . . intent Σ 1..1 code proposal | plan | order +
RequestIntent (Required)
. . . priority 0..1 code normal | urgent | asap | stat
RequestPriority (Required)
. . . code Σ 0..1 CodeableConcept Task Type
. . . description Σ 0..1 string Human-readable explanation of task
. . . focus Σ 0..1 Reference(Any) What task is acting on
. . . for Σ 0..1 Reference(Any) Beneficiary of the Task
. . . context Σ 0..1 Reference(Encounter | EpisodeOfCare) Healthcare event during which this task originated
. . . executionPeriod Σ 0..1 Period Start and end time of execution
. . . authoredOn I 0..1 dateTime Task Creation Date
. . . lastModified Σ I 0..1 dateTime Task Last Modified Date
. . . requester Σ 0..1 BackboneElement Who is asking for task to be done
. . . . agent Σ 1..1 Reference(Device | Organization | Patient | Practitioner | RelatedPerson) Individual asking for task
. . . . onBehalfOf 0..1 Reference(Organization) Organization individual is acting for
. . . performerType 0..* CodeableConcept requester | dispatcher | scheduler | performer | monitor | manager | acquirer | reviewer
TaskPerformerType (Preferred)
. . . owner Σ 0..1 Reference(Device | Organization | Patient | Practitioner | RelatedPerson) Responsible individual
. . . reason 0..1 CodeableConcept Why task is needed
. . . note 0..* Annotation Comments made about the task
. . . relevantHistory 0..* Reference(Provenance) Key events in history of the Task
. . . restriction 0..1 BackboneElement Constraints on fulfillment tasks
. . . . repetitions 0..1 positiveInt How many times to repeat
. . . . period 0..1 Period When fulfillment sought
. . . . recipient 0..* Reference(Patient | Practitioner | RelatedPerson | Group | Organization) For whom is fulfillment sought?
. . . input 0..* BackboneElement Information used to perform task
. . . . type 1..1 CodeableConcept Label for the input
. . . . value[x] 1..1 * Content to use in performing the task
. . . output 0..* BackboneElement Information produced as part of task
. . . . type 1..1 CodeableConcept Label for output
. . . . value[x] 1..1 * Result of output

doco Documentation for this format
Name Flags Card. Type Description & Constraints doco
. . TestReport DomainResource Describes the results of a TestScript execution
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
. . . identifier Σ 0..1 Identifier External identifier
. . . name Σ 0..1 string Informal name of the executed TestScript
. . . status ?! Σ 1..1 code completed | in-progress | waiting | stopped | entered-in-error
TestReportStatus (Required)
. . . testScript Σ 1..1 Reference(TestScript) Reference to the version-specific TestScript that was executed to produce this TestReport
. . . result Σ 1..1 code pass | fail | pending
TestReportResult (Required)
. . . score Σ 0..1 decimal The final score (percentage of tests passed) resulting from the execution of the TestScript
. . . tester Σ 0..1 string Name of the tester producing this report (Organization or individual)
. . . issued Σ 0..1 dateTime When the TestScript was executed and this TestReport was generated
. . . participant 0..* BackboneElement A participant in the test execution, either the execution engine, a client, or a server
. . . . type 1..1 code test-engine | client | server
TestReportParticipantType (Required)
. . . . uri 1..1 uri The uri of the participant. An absolute URL is preferred
. . . . display 0..1 string The display name of the participant
. . . setup 0..1 BackboneElement The results of the series of required setup operations before the tests were executed
. . . . action I 1..* BackboneElement A setup operation or assert that was executed
+ Setup action SHALL contain either an operation or assert but not both.
. . . . . operation 0..1 BackboneElement The operation to perform
. . . . . . result 1..1 code pass | skip | fail | warning | error
TestReportActionResult (Required)
. . . . . . message 0..1 markdown A message associated with the result
. . . . . . detail 0..1 uri A link to further details on the result
. . . . . assert 0..1 BackboneElement The assertion to perform
. . . . . . result 1..1 code pass | skip | fail | warning | error
TestReportActionResult (Required)
. . . . . . message 0..1 markdown A message associated with the result
. . . . . . detail 0..1 string A link to further details on the result
. . . test 0..* BackboneElement A test executed from the test script
. . . . name 0..1 string Tracking/logging name of this test
. . . . description 0..1 string Tracking/reporting short description of the test
. . . . action I 1..* BackboneElement A test operation or assert that was performed
+ Test action SHALL contain either an operation or assert but not both.
. . . . . operation 0..1 see operation The operation performed
. . . . . assert 0..1 see assert The assertion performed
. . . teardown 0..1 BackboneElement The results of running the series of required clean up steps
. . . . action 1..* BackboneElement One or more teardown operations performed
. . . . . operation 1..1 see operation The teardown operation performed

doco Documentation for this format
Name Flags Card. Type Description & Constraints doco
. . TestScript DomainResource Describes a set of tests
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
. . . url Σ 1..1 uri Logical URI to reference this test script (globally unique)
. . . identifier Σ 0..1 Identifier Additional identifier for the test script
. . . version Σ 0..1 string Business version of the test script
. . . name Σ 1..1 string Name for this test script (computer friendly)
. . . title Σ 0..1 string Name for this test script (human friendly)
. . . status ?! Σ 1..1 code draft | active | retired | unknown
PublicationStatus (Required)
. . . experimental ?! Σ 0..1 boolean For testing purposes, not real usage
. . . date Σ 0..1 dateTime Date this was last changed
. . . publisher Σ 0..1 string Name of the publisher (organization or individual)
. . . contact Σ 0..* ContactDetail Contact details for the publisher
. . . description 0..1 markdown Natural language description of the test script
. . . useContext Σ 0..* UsageContext Context the content is intended to support
. . . jurisdiction Σ 0..* CodeableConcept Intended jurisdiction for test script (if applicable)
Jurisdiction ValueSet (Extensible)
. . . purpose 0..1 markdown Why this test script is defined
. . . copyright 0..1 markdown Use and/or publishing restrictions
. . . origin 0..* BackboneElement An abstract server representing a client or sender in a message exchange
. . . . index 1..1 integer The index of the abstract origin server starting at 1
. . . . profile 1..1 Coding FHIR-Client | FHIR-SDC-FormFiller
TestScriptProfileOriginType (Extensible)
. . . destination 0..* BackboneElement An abstract server representing a destination or receiver in a message exchange
. . . . index 1..1 integer The index of the abstract destination server starting at 1
. . . . profile 1..1 Coding FHIR-Server | FHIR-SDC-FormManager | FHIR-SDC-FormReceiver | FHIR-SDC-FormProcessor
TestScriptProfileDestinationType (Extensible)
. . . metadata I 0..1 BackboneElement Required capability that is assumed to function correctly on the FHIR server being tested
+ TestScript metadata capability SHALL contain required or validated or both.
. . . . link 0..* BackboneElement Links to the FHIR specification
. . . . . url 1..1 uri URL to the specification
. . . . . description 0..1 string Short description
. . . . capability 1..* BackboneElement Capabilities that are assumed to function correctly on the FHIR server being tested
. . . . . required 0..1 boolean Are the capabilities required?
. . . . . validated 0..1 boolean Are the capabilities validated?
. . . . . description 0..1 string The expected capabilities of the server
. . . . . origin 0..* integer Which origin server these requirements apply to
. . . . . destination 0..1 integer Which server these requirements apply to
. . . . . link 0..* uri Links to the FHIR specification
. . . . . capabilities 1..1 Reference(CapabilityStatement) Required Capability Statement
. . . fixture 0..* BackboneElement Fixture in the test script - by reference (uri)
. . . . autocreate 0..1 boolean Whether or not to implicitly create the fixture during setup
. . . . autodelete 0..1 boolean Whether or not to implicitly delete the fixture during teardown
. . . . resource 0..1 Reference(Any) Reference of the resource
. . . profile 0..* Reference(Any) Reference of the validation profile
. . . variable I 0..* BackboneElement Placeholder for evaluated elements
+ Variable can only contain one of expression, headerField or path.
. . . . name 1..1 string Descriptive name for this variable
. . . . defaultValue 0..1 string Default, hard-coded, or user-defined value for this variable
. . . . description 0..1 string Natural language description of the variable
. . . . expression 0..1 string The fluentpath expression against the fixture body
. . . . headerField 0..1 string HTTP header field name for source
. . . . hint 0..1 string Hint help text for default value to enter
. . . . path 0..1 string XPath or JSONPath against the fixture body
. . . . sourceId 0..1 id Fixture Id of source expression or headerField within this variable
. . . rule 0..* BackboneElement Assert rule used within the test script
. . . . resource 1..1 Reference(Any) Assert rule resource reference
. . . . param 0..* BackboneElement Rule parameter template
. . . . . name 1..1 string Parameter name matching external assert rule parameter
. . . . . value 0..1 string Parameter value defined either explicitly or dynamically
. . . ruleset 0..* BackboneElement Assert ruleset used within the test script
. . . . resource 1..1 Reference(Any) Assert ruleset resource reference
. . . . rule 1..* BackboneElement The referenced rule within the ruleset
. . . . . ruleId 1..1 id Id of referenced rule within the ruleset
. . . . . param 0..* BackboneElement Ruleset rule parameter template
. . . . . . name 1..1 string Parameter name matching external assert ruleset rule parameter
. . . . . . value 0..1 string Parameter value defined either explicitly or dynamically
. . . setup 0..1 BackboneElement A series of required setup operations before tests are executed
. . . . action I 1..* BackboneElement A setup operation or assert to perform
+ Setup action SHALL contain either an operation or assert but not both.
. . . . . operation I 0..1 BackboneElement The setup operation to perform
+ Setup operation SHALL contain either sourceId or targetId or params or url.
. . . . . . type 0..1 Coding The operation code type that will be executed
TestScriptOperationCode (Extensible)
. . . . . . resource 0..1 code Resource type
FHIRDefinedType (Required)
. . . . . . label 0..1 string Tracking/logging operation label
. . . . . . description 0..1 string Tracking/reporting operation description
. . . . . . accept 0..1 code xml | json | ttl | none
ContentType (Required)
. . . . . . contentType 0..1 code xml | json | ttl | none
ContentType (Required)
. . . . . . destination 0..1 integer Server responding to the request
. . . . . . encodeRequestUrl 0..1 boolean Whether or not to send the request url in encoded format
. . . . . . origin 0..1 integer Server initiating the request
. . . . . . params 0..1 string Explicitly defined path parameters
. . . . . . requestHeader 0..* BackboneElement Each operation can have one or more header elements
. . . . . . . field 1..1 string HTTP header field name
. . . . . . . value 1..1 string HTTP headerfield value
. . . . . . requestId 0..1 id Fixture Id of mapped request
. . . . . . responseId 0..1 id Fixture Id of mapped response
. . . . . . sourceId 0..1 id Fixture Id of body for PUT and POST requests
. . . . . . targetId 0..1 id Id of fixture used for extracting the [id], [type], and [vid] for GET requests
. . . . . . url 0..1 string Request URL
. . . . . assert I 0..1 BackboneElement The assertion to perform
+ Only a single assertion SHALL be present within setup action assert element.
+ Setup action assert SHALL contain either compareToSourceId and compareToSourceExpression, compareToSourceId and compareToSourcePath or neither.
+ Setup action assert response and responseCode SHALL be empty when direction equals request
. . . . . . label 0..1 string Tracking/logging assertion label
. . . . . . description 0..1 string Tracking/reporting assertion description
. . . . . . direction 0..1 code response | request
AssertionDirectionType (Required)
. . . . . . compareToSourceId 0..1 string Id of the source fixture to be evaluated
. . . . . . compareToSourceExpression 0..1 string The fluentpath expression to evaluate against the source fixture
. . . . . . compareToSourcePath 0..1 string XPath or JSONPath expression to evaluate against the source fixture
. . . . . . contentType 0..1 code xml | json | ttl | none
ContentType (Required)
. . . . . . expression 0..1 string The fluentpath expression to be evaluated
. . . . . . headerField 0..1 string HTTP header field name
. . . . . . minimumId 0..1 string Fixture Id of minimum content resource
. . . . . . navigationLinks 0..1 boolean Perform validation on navigation links?
. . . . . . operator 0..1 code equals | notEquals | in | notIn | greaterThan | lessThan | empty | notEmpty | contains | notContains | eval
AssertionOperatorType (Required)
. . . . . . path 0..1 string XPath or JSONPath expression
. . . . . . requestMethod 0..1 code delete | get | options | patch | post | put
TestScriptRequestMethodCode (Required)
. . . . . . requestURL 0..1 string Request URL comparison value
. . . . . . resource 0..1 code Resource type
FHIRDefinedType (Required)
. . . . . . response 0..1 code okay | created | noContent | notModified | bad | forbidden | notFound | methodNotAllowed | conflict | gone | preconditionFailed | unprocessable
AssertionResponseTypes (Required)
. . . . . . responseCode 0..1 string HTTP response code to test
. . . . . . rule 0..1 BackboneElement The reference to a TestScript.rule
. . . . . . . ruleId 1..1 id Id of the TestScript.rule
. . . . . . . param 0..* BackboneElement Rule parameter template
. . . . . . . . name 1..1 string Parameter name matching external assert rule parameter
. . . . . . . . value 1..1 string Parameter value defined either explicitly or dynamically
. . . . . . ruleset 0..1 BackboneElement The reference to a TestScript.ruleset
. . . . . . . rulesetId 1..1 id Id of the TestScript.ruleset
. . . . . . . rule 0..* BackboneElement The referenced rule within the ruleset
. . . . . . . . ruleId 1..1 id Id of referenced rule within the ruleset
. . . . . . . . param 0..* BackboneElement Rule parameter template
. . . . . . . . . name 1..1 string Parameter name matching external assert ruleset rule parameter
. . . . . . . . . value 1..1 string Parameter value defined either explicitly or dynamically
. . . . . . sourceId 0..1 id Fixture Id of source expression or headerField
. . . . . . validateProfileId 0..1 id Profile Id of validation profile reference
. . . . . . value 0..1 string The value to compare to
. . . . . . warningOnly 0..1 boolean Will this assert produce a warning only on error?
. . . test 0..* BackboneElement A test in this script
. . . . name 0..1 string Tracking/logging name of this test
. . . . description 0..1 string Tracking/reporting short description of the test
. . . . action I 1..* BackboneElement A test operation or assert to perform
+ Test action SHALL contain either an operation or assert but not both.
. . . . . operation I 0..1 see operation The setup operation to perform
+ Test operation SHALL contain either sourceId or targetId or params or url.
. . . . . assert I 0..1 see assert The setup assertion to perform
+ Only a single assertion SHALL be present within test action assert element.
+ Test action assert SHALL contain either compareToSourceId and compareToSourceExpression, compareToSourceId and compareToSourcePath or neither.
+ Test action assert response and response and responseCode SHALL be empty when direction equals request
. . . teardown 0..1 BackboneElement A series of required clean up steps
. . . . action 1..* BackboneElement One or more teardown operations to perform
. . . . . operation I 1..1 see operation The teardown operation to perform
+ Teardown operation SHALL contain either sourceId or targetId or params or url.

doco Documentation for this format
Name Flags Card. Type Description & Constraints doco
. . ValueSet I DomainResource A set of codes drawn from one or more code systems
+ Value set SHALL contain at least one of a compose or an expansion element
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
. . . url Σ 0..1 uri Logical URI to reference this value set (globally unique)
. . . identifier Σ 0..* Identifier Additional identifier for the value set
. . . version Σ 0..1 string Business version of the value set
. . . name Σ 0..1 string Name for this value set (computer friendly)
. . . title Σ 0..1 string Name for this value set (human friendly)
. . . status ?! Σ 1..1 code draft | active | retired | unknown
PublicationStatus (Required)
. . . experimental ?! Σ 0..1 boolean For testing purposes, not real usage
. . . date Σ 0..1 dateTime Date this was last changed
. . . publisher Σ 0..1 string Name of the publisher (organization or individual)
. . . contact Σ 0..* ContactDetail Contact details for the publisher
. . . description 0..1 markdown Natural language description of the value set
. . . useContext Σ 0..* UsageContext Context the content is intended to support
. . . jurisdiction Σ 0..* CodeableConcept Intended jurisdiction for value set (if applicable)
Jurisdiction ValueSet (Extensible)
. . . immutable Σ 0..1 boolean Indicates whether or not any change to the content logical definition may occur
. . . purpose 0..1 markdown Why this value set is defined
. . . copyright 0..1 markdown Use and/or publishing restrictions
. . . extensible Σ 0..1 boolean Whether this is intended to be used with an extensible binding
. . . compose I 0..1 BackboneElement Definition of the content of the value set (CLD)
. . . . lockedDate Σ 0..1 date Fixed date for version-less references (transitive)
. . . . inactive Σ 0..1 boolean Whether inactive codes are in the value set
. . . . include Σ I 1..* BackboneElement Include one or more codes from a code system or other value set(s)
+ A value set with concepts or filters SHALL include a system
+ Cannot have both concept and filter
+ A value set include/exclude SHALL have a value set or a system
. . . . . system Σ I 0..1 uri The system the codes come from
. . . . . version Σ 0..1 string Specific version of the code system referred to
. . . . . concept I 0..* BackboneElement A concept defined in the system
. . . . . . code 1..1 code Code or expression from system
. . . . . . display 0..1 string Text to display for this code for this value set in this valueset
. . . . . . designation 0..* BackboneElement Additional representations for this concept
. . . . . . . language 0..1 code Human language of the designation
Common Languages (Extensible but limited to All Languages)
. . . . . . . use 0..1 Coding Details how this designation would be used
Designation Use (Extensible)
. . . . . . . value 1..1 string The text value for this designation
. . . . . filter ?! Σ I 0..* BackboneElement Select codes/concepts by their properties (including relationships)
. . . . . . property Σ 1..1 code A property defined by the code system
. . . . . . op Σ 1..1 code = | is-a | descendent-of | is-not-a | regex | in | not-in | generalizes | exists
FilterOperator (Required)
. . . . . . value Σ 1..1 code Code from the system, or regex criteria, or boolean value for exists
. . . . . valueSet Σ I 0..* uri Select only contents included in this value set
. . . . exclude I 0..* see include Explicitly exclude codes from a code system or other value sets
. . . expansion I 0..1 BackboneElement Used when the value set is "expanded"
. . . . identifier 1..1 uri Uniquely identifies this expansion
. . . . timestamp 1..1 dateTime Time ValueSet expansion happened
. . . . total 0..1 integer Total number of codes in the expansion
. . . . offset 0..1 integer Offset at which this resource starts
. . . . parameter 0..* BackboneElement Parameter that controlled the expansion process
. . . . . name 1..1 string Name as assigned by the server
. . . . . value[x] 0..1 Value of the named parameter
. . . . . . valueString string
. . . . . . valueBoolean boolean
. . . . . . valueInteger integer
. . . . . . valueDecimal decimal
. . . . . . valueUri uri
. . . . . . valueCode code
. . . . contains I 0..* BackboneElement Codes in the value set
+ SHALL have a code or a display
+ Must have a code if not abstract
+ Must have a system if a code is present
. . . . . system 0..1 uri System value for the code
. . . . . abstract 0..1 boolean If user cannot select this entry
. . . . . inactive 0..1 boolean If concept is inactive in the code system
. . . . . version 0..1 string Version in which this code/display is defined
. . . . . code I 0..1 code Code - if blank, this is not a selectable code
. . . . . display I 0..1 string User display for the concept
. . . . . designation 0..* see designation Additional representations for this item
. . . . . contains 0..* see contains Codes contained under this entry

doco Documentation for this format
Name Flags Card. Type Description & Constraints doco
. . VisionPrescription DomainResource Prescription for vision correction products for a patient
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
. . . identifier 0..* Identifier Business identifier
. . . status ?! Σ 0..1 code active | cancelled | draft | entered-in-error
Financial Resource Status Codes (Required)
. . . patient 0..1 Reference(Patient) Who prescription is for
. . . encounter 0..1 Reference(Encounter) Created during encounter / admission / stay
. . . dateWritten 0..1 dateTime When prescription was authorized
. . . prescriber 0..1 Reference(Practitioner) Who authorizes the vision product
. . . reason[x] 0..1 Reason or indication for writing the prescription
. . . . reasonCodeableConcept CodeableConcept
. . . . reasonReference Reference(Condition)
. . . dispense 0..* BackboneElement Vision supply authorization
. . . . product 0..1 CodeableConcept Product to be supplied
Example Vision Prescription Product Codes (Example)
. . . . eye 0..1 code right | left
VisionEyes (Required)
. . . . sphere 0..1 decimal Lens sphere
. . . . cylinder 0..1 decimal Lens cylinder
. . . . axis 0..1 integer Lens axis
. . . . prism 0..1 decimal Lens prism
. . . . base 0..1 code up | down | in | out
VisionBase (Required)
. . . . add 0..1 decimal Lens add
. . . . power 0..1 decimal Contact lens power
. . . . backCurve 0..1 decimal Contact lens back curvature
. . . . diameter 0..1 decimal Contact lens diameter
. . . . duration 0..1 SimpleQuantity Lens wear duration
. . . . color 0..1 string Color required
. . . . brand 0..1 string Brand required
. . . . note 0..* Annotation Notes for coatings

doco Documentation for this format
Name Flags Card. Type Description & Constraints doco
. . MetadataResource DomainResource Common Ancestor declaration for definitional resources
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
. . . url Σ 0..1 uri Logical URI to reference this metadata resource (globally unique)
. . . version Σ 0..1 string Business version of the metadata resource
. . . name Σ 0..1 string Name for this metadata resource (computer friendly)
. . . title Σ 0..1 string Name for this metadata resource (human friendly)
. . . status ?! Σ 1..1 code draft | active | retired | unknown
PublicationStatus (Required)
. . . experimental ?! Σ 0..1 boolean For testing purposes, not real usage
. . . date Σ 0..1 dateTime Date this was last changed
. . . publisher Σ 0..1 string Name of the publisher (organization or individual)
. . . contact Σ 0..* ContactDetail Contact details for the publisher
. . . useContext Σ 0..* UsageContext Context the content is intended to support
. . . jurisdiction Σ 0..* CodeableConcept Intended jurisdiction for metadata resource (if applicable)
Jurisdiction ValueSet (Extensible)
. . . description 0..1 markdown Natural language description of the metadata resource

doco Documentation for this format