Data Types and Payloads

Identifier

Properties:

name	cardinality	description	value
root	1..1		string
extension	0..1		string

TextWithReference

Properties:

name	cardinality	description	value
text	0..*		string
reference	0..1		string

ConceptDescriptor

Properties:

name	cardinality	description	value
label	0..1		string
code	1..1		string
system	1..1		string
systemName	0..1		string
nullFlavor	0..1		string
translations	0..*		ConceptDescriptor

SimpifiedCode

Properties:

name	cardinality	description	value
label	0..1		string
code	1..1		string
system	1..1		string
systemName	0..1		string
nullFlavor	0..1		string
translations	0..*		ConceptDescriptor

Address

Properties:

name	cardinality	description	value
streetLines	1..4		string
city	1..1		string
state	0..1		string
zip	0..1		string
country	0..1		string
use	0..1		string

Name

Properties:

name	cardinality	description	value
prefixes	0..*		string
givens	1..*		string
family	1..1		string
suffix	0..1		string
use	0..1		string

Telecom

Properties:

name	cardinality	description	value
value	1..1		string
use	0..1		string

Guardian

Properties:

name	cardinality	description	value
relation	0..1		SimpifiedCode
addresses	0..*		Address
names	1..*		Name
telecoms	0..*		Telecom

LanguageCommunication

Properties:

name	cardinality	description	value
mode	0..1		SimpifiedCode
proficiency	0..1		SimpifiedCode
code	1..1		string
preferred	1..1		boolean

PhysicalQuantity

Properties:

name	cardinality	description	value
value	1..1		string
unit	0..1		string

EffectiveTime

Properties:

name	cardinality	description	value
point	0..1		undefined
pointResolution	0..1		string: year | month | day | hour | minute | second | subsecond
low	0..1		undefined
lowResolution	0..1		string: year | month | day | hour | minute | second | subsecond
high	0..1		undefined
highResolution	0..1		string: year | month | day | hour | minute | second | subsecond
operator	0..1		string
xsitype	0..1		string
period	0..1		PhysicalQuantity

ProblemObservation

Properties:

name	cardinality	description	value
sourceIds	1..*		Identifier
problemType	1..1		ConceptDescriptor
problemName	1..1		ConceptDescriptor
freeTextProblemName	0..1		TextWithReference
dateRange	1..1		EffectiveTime
resolved	1..1		undefined
ageAtOnset	0..1		PhysicalQuantity
problemStatus	0..1		ConceptDescriptor
healthStatus	0..1		ConceptDescriptor

NonProblemObservation

Properties:

name	cardinality	description	value
sourceIds	1..*		Identifier
problemType	1..1		ConceptDescriptor
problemName	1..1		ConceptDescriptor
freeTextProblemName	0..1		TextWithReference
dateRange	1..1		EffectiveTime
resolved	1..1		undefined
ageAtOnset	0..1		PhysicalQuantity
problemStatus	0..1		ConceptDescriptor
healthStatus	0..1		ConceptDescriptor

ProblemOrganizer

Properties:

name	cardinality	description	value
sourceIds	1..*		Identifier
dateRange	1..1		EffectiveTime
concernStatus	1..1		string
problems	1..*		ProblemObservation
nonProblems	0..*		NonProblemObservation

ProblemsSection

Properties:

name	cardinality	description	value
problemConcerns	0..*		ProblemOrganizer

VitalSignObservation

Properties:

name	cardinality	description	value
sourceIds	1..*		Identifier
vitalName	1..1		ConceptDescriptor
measuredAt	1..1		EffectiveTime
physicalQuantity	1..1		PhysicalQuantity
freeTextValue	0..1		TextWithReference
interpretations	0..*		SimpifiedCode

VitalSignsOrganizer

Properties:

name	cardinality	description	value
panelName	0..1		ConceptDescriptor
sourceIds	1..*		Identifier
vitals	1..*		VitalSignObservation

VitalSignsSection

Properties:

name	cardinality	description	value
panels	0..*		VitalSignsOrganizer

ImmunizationInformation

Properties:

name	cardinality	description	value
productName	0..1		ConceptDescriptor
freeTextProductName	0..1		TextWithReference
lotNumber	0..1		string

ImmunizationActivity

Properties:

name	cardinality	description	value
sourceIds	1..*		Identifier
deliveryMethod	0..1		ConceptDescriptor
route	0..1		SimpifiedCode
site	0..1		ConceptDescriptor
administrationUnit	0..1		ConceptDescriptor
date	1..1		EffectiveTime
seriesNumber	0..1		EffectiveTime
freeText	0..1		TextWithReference
skippedFor	0..1		SimpifiedCode
productName	0..1		ConceptDescriptor
freeTextProductName	0..1		TextWithReference
lotNumber	0..1		string

PlannedImmunization

Properties:

name	cardinality	description	value
sourceIds	1..*		Identifier
deliveryMethod	0..1		ConceptDescriptor
route	0..1		SimpifiedCode
site	0..1		ConceptDescriptor
administrationUnit	0..1		ConceptDescriptor
date	1..1		EffectiveTime
seriesNumber	0..1		EffectiveTime
freeText	0..1		TextWithReference
skippedFor	0..1		SimpifiedCode
productName	0..1		ConceptDescriptor
freeTextProductName	0..1		TextWithReference
lotNumber	0..1		string

RefusedImmunization

Properties:

name	cardinality	description	value
sourceIds	1..*		Identifier
deliveryMethod	0..1		ConceptDescriptor
route	0..1		SimpifiedCode
site	0..1		ConceptDescriptor
administrationUnit	0..1		ConceptDescriptor
date	1..1		EffectiveTime
seriesNumber	0..1		EffectiveTime
freeText	0..1		TextWithReference
skippedFor	0..1		SimpifiedCode
productName	0..1		ConceptDescriptor
freeTextProductName	0..1		TextWithReference
lotNumber	0..1		string

ImmunizationsSection

Properties:

name	cardinality	description	value
immunizationsGiven	0..*		ImmunizationActivity
immunizationsPlanned	0..*		PlannedImmunization
immunizationsSkipped	0..*		RefusedImmunization

MedicationInformation

Properties:

name	cardinality	description	value
productName	0..1		ConceptDescriptor{"valueSetOid":"2.16.840.1.113883.3.88.12.80.17"}
freeTextProductName	0..1		TextWithReference

ConceptDescriptor{"valueSetOid":"2.16.840.1.113883.3.88.12.80.17"}

Properties:

name	cardinality	description	value
label	0..1		string
code	1..1		string
system	1..1		string
systemName	0..1		string
nullFlavor	0..1		string
translations	0..*		ConceptDescriptor

MedicationActivity

Properties:

name	cardinality	description	value
sourceIds	1..*		Identifier
deliveryMethod	0..1		ConceptDescriptor
route	0..1		SimpifiedCode
site	0..1		ConceptDescriptor
administrationUnit	0..1		ConceptDescriptor
times	0..2		EffectiveTime
dateRange	0..1		EffectiveTime
dosePeriod	0..1		PhysicalQuantity
freeTextSig	0..1		TextWithReference
dose	0..1		PhysicalQuantity
rate	0..1		PhysicalQuantity
productName	0..1		ConceptDescriptor{"valueSetOid":"2.16.840.1.113883.3.88.12.80.17"}
freeTextProductName	0..1		TextWithReference

Prescription

Properties:

name	cardinality	description	value
sourceIds	1..*		Identifier
deliveryMethod	0..1		ConceptDescriptor
route	0..1		SimpifiedCode
site	0..1		ConceptDescriptor
administrationUnit	0..1		ConceptDescriptor
times	0..2		EffectiveTime
dateRange	0..1		EffectiveTime
dosePeriod	0..1		PhysicalQuantity
freeTextSig	0..1		TextWithReference
dose	0..1		PhysicalQuantity
rate	0..1		PhysicalQuantity
productName	0..1		ConceptDescriptor{"valueSetOid":"2.16.840.1.113883.3.88.12.80.17"}
freeTextProductName	0..1		TextWithReference

MedActivityHx

Properties:

name	cardinality	description	value
sourceIds	1..*		Identifier
deliveryMethod	0..1		ConceptDescriptor
route	0..1		SimpifiedCode
site	0..1		ConceptDescriptor
administrationUnit	0..1		ConceptDescriptor
times	0..2		EffectiveTime
dateRange	0..1		EffectiveTime
dosePeriod	0..1		PhysicalQuantity
freeTextSig	0..1		TextWithReference
dose	0..1		PhysicalQuantity
rate	0..1		PhysicalQuantity
productName	0..1		ConceptDescriptor{"valueSetOid":"2.16.840.1.113883.3.88.12.80.17"}
freeTextProductName	0..1		TextWithReference

SmokingStatusObservation

Properties:

name	cardinality	description	value
sourceIds	1..*		Identifier
smokingStatus	0..1		ConceptDescriptor{"valueSetOid":"2.16.840.1.113883.11.20.9.38"}
dateRange	1..1		EffectiveTime

ConceptDescriptor{"valueSetOid":"2.16.840.1.113883.11.20.9.38"}

Properties:

name	cardinality	description	value
label	0..1		string
code	1..1		string
system	1..1		string
systemName	0..1		string
nullFlavor	0..1		string
translations	0..*		ConceptDescriptor

SocialHistorySection

Properties:

name	cardinality	description	value
smokingStatuses	0..*		SmokingStatusObservation

MedicationsSection

Properties:

name	cardinality	description	value
medicationsPrescribed	0..*		Prescription
medicationsReported	0..*		MedActivityHx

ResultObservation

Properties:

name	cardinality	description	value
sourceIds	1..*		Identifier
resultName	1..1		ConceptDescriptor
measuredAt	1..1		EffectiveTime
physicalQuantity	1..1		PhysicalQuantity
freeTextValue	0..1		TextWithReference
interpretations	0..*		SimpifiedCode

ResultsOrganizer

Properties:

name	cardinality	description	value
sourceIds	1..*		Identifier
panelName	0..1		ConceptDescriptor
results	1..*		ResultObservation

ResultsSection

Properties:

name	cardinality	description	value
panels	0..*		ResultsOrganizer

Patient

Properties:

name	cardinality	description	value
name	1..1		Name
maritalStatus	0..1		SimpifiedCode{"valueSetOid":"2.16.840.1.113883.1.11.12212"}
religion	0..1		ConceptDescriptor
race	0..1		ConceptDescriptor
ethnicity	0..1		ConceptDescriptor
addresses	0..*		Address
guardians	0..*		Guardian
telecoms	0..*		Telecom
languages	0..*		LanguageCommunication
medicalRecordNumbers	1..*		Identifier
gender	1..1		SimpifiedCode
birthTime	1..1		undefined
birthTimeResolution	1..1		string: year | month | day | hour | minute | second | subsecond

SimpifiedCode{"valueSetOid":"2.16.840.1.113883.1.11.12212"}

Properties:

name	cardinality	description	value
label	0..1		string
code	1..1		string
system	1..1		string
systemName	0..1		string
nullFlavor	0..1		string
translations	0..*		ConceptDescriptor

CCDA

Properties:

name	cardinality	description	value
sourceIds	1..*		Identifier
demographics	1..1		Patient
vitals	0..1		VitalSignsSection
results	0..1		ResultsSection
medications	0..1		MedicationsSection
immunizations	0..1		ImmunizationsSection
socialHistory	0..1		SocialHistorySection
problems	0..1		ProblemsSection