fhir docs organised in one place

Clinical

Summary

AdverseEvent
AllergyIntolerance
ClinicalImpression
Condition
DetectedIssue
FamilyMemberHistory
Procedure

Diagnostics

BodyStructure
DiagnosticReport
ImagingStudy
Media
MolecularSequence
Observation
QuestionnaireResponse
Specimen

Care Provision

CarePlan
CareTeam
Goal
NutritionOrder
RequestGroup
RiskAssessment
ServiceRequest
VisionPrescription

Request & Response

Communication
CommunicationRequest
DeviceRequest
DeviceUseStatement
GuidanceResponse
SupplyDelivery
SupplyRequest

Medications

Immunization
ImmunizationEvaluation
ImmunizationRecommendation
Medication
MedicationAdministration
MedicationDispense
MedicationKnowledge
MedicationRequest
MedicationStatement

Base

Workflow

Appointment
AppointmentResponse
Schedule
Slot
Task
VerificationResult

Entities

BiologicallyDerivedProduct
Device
DeviceMetric
Endpoint
HealthcareService
Location
Organization
OrganizationAffiliation
Substance

Management

Encounter
EpisodeOfCare
Flag
Library
List

Individuals

Group
Patient
Person
Practitioner
PractitionerRole
RelatedPerson

Financial

General

Account
ChargeItem
ChargeItemDefinition
Contract
ExplanationOfBenefit
InsurancePlan

Billing

Claim
ClaimResponse
Invoice

Support

Coverage
CoverageEligibilityRequest
CoverageEligibilityResponse
EnrollmentRequest
EnrollmentResponse

Payment

PaymentNotice
PaymentReconciliation

Foundation

Security

AuditEvent
Consent
Provenance

Other

Basic
Binary
Bundle
Linkage
MessageHeader
OperationOutcome
Parameters
Subscription

Conformance

CapabilityStatement
CompartmentDefinition
ExampleScenario
GraphDefinition
ImplementationGuide
MessageDefinition
OperationDefinition
SearchParameter
StructureDefinition
StructureMap

Documents

CatalogEntry
Composition
DocumentManifest
DocumentReference

Terminology

CodeSystem
ConceptMap
NamingSystem
TerminologyCapabilities
ValueSet

Specialized

Definitional Artifacts

ActivityDefinition
DeviceDefinition
EventDefinition
ObservationDefinition
PlanDefinition
Questionnaire
SpecimenDefinition

Evidence-Based Medicine

EffectEvidenceSynthesis
Evidence
EvidenceVariable
ResearchDefinition
ResearchElementDefinition
RiskEvidenceSynthesis

Quality Reporting & Testing

Measure
MeasureReport
TestReport
TestScript

Medication Definition

MedicinalProduct
MedicinalProductAuthorization
MedicinalProductContraindication
MedicinalProductIndication
MedicinalProductIngredient
MedicinalProductInteraction
MedicinalProductManufactured
MedicinalProductPackaged
MedicinalProductPharmaceutical
MedicinalProductUndesirableEffect
SubstanceNucleicAcid
SubstancePolymer
SubstanceProtein
SubstanceReferenceInformation
SubstanceSourceMaterial
SubstanceSpecification

Public Health & Research

ResearchStudy
ResearchSubject

Types

Complex

Element
BackboneElement
Address
Age
Annotation
Attachment
CodeableConcept
Coding
ContactDetail
ContactPoint
Contributor
Count
DataRequirement
Distance
Dosage
Duration
ElementDefinition
Expression
Extension
HumanName
Identifier
MarketingStatus
Meta
Money
Narrative
ParameterDefinition
Period
Population
ProdCharacteristic
ProductShelfLife
Quantity
Range
Ratio
Reference
RelatedArtifact
SampledData
Signature
SubstanceAmount
Timing
TriggerDefinition
UsageContext
MoneyQuantity
SimpleQuantity

Primitive

base64Binary
boolean
canonical
code
date
dateTime
decimal
id
instant
integer
markdown
oid
positiveInt
string
time
unsignedInt
uri
url
uuid
xhtml

Operations

ActivityDefinition

ActivityDefinition-apply
ActivityDefinition-data-requirements

CapabilityStatement

CapabilityStatement-conforms
CapabilityStatement-implements
CapabilityStatement-subset
CapabilityStatement-versions

ChargeItemDefinition

ChargeItemDefinition-apply

Claim

Claim-submit

CodeSystem

CodeSystem-find-matches
CodeSystem-lookup
CodeSystem-subsumes
CodeSystem-validate-code

Composition

Composition-document

ConceptMap

ConceptMap-closure
ConceptMap-translate

CoverageEligibilityRequest

CoverageEligibilityRequest-submit

Encounter

Encounter-everything

Group

Group-everything

Library

Library-data-requirements

List

List-find

Measure

Measure-care-gaps
Measure-collect-data
Measure-data-requirements
Measure-evaluate-measure
Measure-submit-data

MedicinalProduct

MedicinalProduct-everything

MessageHeader

MessageHeader-process-message

NamingSystem

NamingSystem-preferred-id

Observation

Observation-lastn
Observation-stats

Patient

Patient-everything
Patient-match

PlanDefinition

PlanDefinition-apply
PlanDefinition-data-requirements

Resource

Resource-convert
Resource-graph
Resource-graphql
Resource-meta
Resource-meta-add
Resource-meta-delete
Resource-validate

StructureDefinition

StructureDefinition-questionnaire
StructureDefinition-snapshot

StructureMap

StructureMap-transform

ValueSet

ValueSet-expand
ValueSet-validate-code

Other

default

base
base2
device-CompartmentDefinition
encounter-CompartmentDefinition
patient-CompartmentDefinition
practitioner-CompartmentDefinition
relatedPerson-CompartmentDefinition
Resource
DomainResource
MetadataResource

ParameterDefinition

STU3 R4 R4B R5

Open Official Docs

Base StructureDefinition for ParameterDefinition Type: The parameters to the module. This collection specifies both the input and output parameters. Input parameters are provided by the caller as part of the $evaluate operation. Output parameters are included in the GuidanceResponse.

ParameterDefinition

Path

ParameterDefinition

Cardinality

0 - *

Definition

The parameters to the module. This collection specifies both the input and output parameters. Input parameters are provided by the caller as part of the $evaluate operation. Output parameters are included in the GuidanceResponse.

Comment

Constraint

ele-1 [error]

All FHIR elements must have a @value or children

Condition

ele-1

name

Summary: The element appears in the summary view

code

Name used to access the parameter value

Path

ParameterDefinition.name

Type

code

Cardinality

0 - 1

Definition

The name of the parameter used to allow access to the value of the parameter in evaluation contexts.

Comment

Constraint

ele-1 [error]

All FHIR elements must have a @value or children

use

code

in | out

Path

ParameterDefinition.use

Type

code

Cardinality

1 - 1

Definition

Whether the parameter is input or output for the module.

Comment

Binding

Strength

required

Description

Whether the parameter is input or output.

ValueSet

http://hl7.org/fhir/ValueSet/operation-parameter-use|4.0.1

Constraint

ele-1 [error]

All FHIR elements must have a @value or children

min

integer

Minimum cardinality

Path

ParameterDefinition.min

Type

integer

Cardinality

0 - 1

Definition

The minimum number of times this parameter SHALL appear in the request or response.

Comment

Constraint

ele-1 [error]

All FHIR elements must have a @value or children

max

string

Maximum cardinality (a number of *)

Path

ParameterDefinition.max

Type

string

Cardinality

0 - 1

Definition

The maximum number of times this element is permitted to appear in the request or response.

Comment

Constraint

ele-1 [error]

All FHIR elements must have a @value or children

documentation

string

A brief description of the parameter

Path

ParameterDefinition.documentation

Type

string

Cardinality

0 - 1

Definition

A brief discussion of what the parameter is for and how it is used by the module.

Comment

Constraint

ele-1 [error]

All FHIR elements must have a @value or children

type

code

What type of value

Path

ParameterDefinition.type

Type

code

Cardinality

1 - 1

Definition

The type of the parameter.

Comment

Binding

Strength

required

Description

A list of all the concrete types defined in this version of the FHIR specification - Abstract Types, Data Types and Resource Types.

ValueSet

http://hl7.org/fhir/ValueSet/all-types|4.0.1

Constraint

ele-1 [error]

All FHIR elements must have a @value or children

profile

canonical

What profile the value is expected to be

Path

ParameterDefinition.profile

Type

canonical

Cardinality

0 - 1

Definition

If specified, this indicates a profile that the input data must conform to, or that the output data will conform to.

Comment

Constraint

ele-1 [error]

All FHIR elements must have a @value or children