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

HumanName

STU3 R4 R4B R5

Open Official Docs

Base StructureDefinition for HumanName Type: A human's name with the ability to identify parts and usage.

HumanName

Path

HumanName

Cardinality

0 - *

Definition

A human's name with the ability to identify parts and usage.

Comment

Names may be changed, or repudiated, or people may have different names in different contexts. Names may be divided into parts of different type that have variable significance depending on context, though the division into parts does not always matter. With personal names, the different parts might or might not be imbued with some implicit meaning; various cultures associate different importance with the name parts and the degree to which systems must care about name parts around the world varies widely.

Constraint

ele-1 [error]

All FHIR elements must have a @value or children

Condition

ele-1

use

Summary: The element appears in the summary view

code

Path

HumanName.use

Type

code

Cardinality

0 - 1

Definition

Identifies the purpose for this name.

Comment

Applications can assume that a name is current unless it explicitly says that it is temporary or old.

Requirements

Allows the appropriate name for a particular context of use to be selected from among a set of names.

Binding

Strength

required

Description

The use of a human name.

ValueSet

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

Constraint

ele-1 [error]

All FHIR elements must have a @value or children

family

string

Family name (often called 'Surname')

Path

HumanName.family

Type

string

Cardinality

0 - 1

Definition

The part of a name that links to the genealogy. In some cultures (e.g. Eritrea) the family name of a son is the first name of his father.

Comment

Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures).

Constraint

ele-1 [error]

All FHIR elements must have a @value or children

given

List: This element is a list and more than one value can be provided

string

Given names (not always 'first'). Includes middle names

Path

HumanName.given

Type

string

Cardinality

0 - *

Definition

Given name.

Comment

If only initials are recorded, they may be used in place of the full name parts. Initials may be separated into multiple given names but often aren't due to paractical limitations. This element is not called "first name" since given names do not always come first.

Constraint

ele-1 [error]

All FHIR elements must have a @value or children

prefix

string

Parts that come before the name

Path

HumanName.prefix

Type

string

Cardinality

0 - *

Definition

Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the start of the name.

Comment

Constraint

ele-1 [error]

All FHIR elements must have a @value or children

suffix

string

Parts that come after the name

Path

HumanName.suffix

Type

string

Cardinality

0 - *

Definition

Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the end of the name.

Comment

Constraint

ele-1 [error]

All FHIR elements must have a @value or children

period

Period

Time period when name was/is in use

Path

HumanName.period

Type

Period

Cardinality

0 - 1

Definition

Indicates the period of time when this name was valid for the named person.

Comment

Requirements

Allows names to be placed in historical context.

Constraint

ele-1 [error]

All FHIR elements must have a @value or children

start

dateTime

Starting time with inclusive boundary

Path

HumanName.period.Period.start

Period.start

Type

dateTime

Cardinality

0 - 1

Definition

The start of the period. The boundary is inclusive.

Comment

If the low element is missing, the meaning is that the low boundary is not known.

Constraint

ele-1 [error]

All FHIR elements must have a @value or children

Condition

per-1

end

dateTime

End time with inclusive boundary, if not ongoing

Path

HumanName.period.Period.end

Period.end

Type

dateTime

Cardinality

0 - 1

Definition

The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.

Comment

The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03.

Constraint

ele-1 [error]

All FHIR elements must have a @value or children

Condition

per-1