FHIM::Datatypes::Datatypes
Diagram Datatypes
This diagram displays all the classes in the FHIM Datatypes package. The FHIM data types are closely aligned with the HL7 FHIR datatypes, which we have found to be the most robust and useful of the datatypes specified by existing Health IT standards. Previously, the FHIM was more closely aligned with the HL7 Version 3 data types, albeit the FHIM datatypes were simplified so that they might be more easily resolved into implementable specifications. Therefore, where a FHIM data type maps to an HL7 V3 data type, we have placed the HL7 data type mnemonic as a keyword, so for example, Person Name has a <> keyword.

It is important to keep in mind that many of these data types will not necessarily be implemented directly, but rather would be substituted with the appropriate data type in the target paradigm.

A note about Person Name is in order: We found the HL7 V3 notion that a person’s given name is an ordered list of names rather than a first name and middle name as traditionally modeled to be a useful construct. But we found that HL7’s modeling each part of the name separately to be overly complex, so we have modeled a single structure made up of several attributes each of which is a string.

Similarly for addresses, we found HL7’s modeling each part of the address separately to be overly complex, so we have modeled a single structure made up of several attributes each of which is a string. Notably, the street portion of the address is simply line1, line2, and line3 rather than modeling each part of the street line separately.

However, unlike our approach for Person Name, for both addresses and telecommunications addresses, we chose a hybrid approach for the use code. We include an address type (the values of which come from the HL7 V3 vocabulary), and we explicitly model the use of the data element in the domain model. For example, Person has both a primaryHomeAddress and a workAddress. The Address.addressTypeCode property would be set to the appropriate value accordingly. This approach was taken in order to explicitly account for the concepts in the logical model (for example, it makes no sense for a hospital to have a home phone number), while acknowledging that phone numbers, addresses, email addresses, etc. will likely be implemented using a mixed bag of addresses, each of which would have some sort of type code.

Datatypes
Dependency Polyline coordinates describing hotspot on the image repeat Property repeat Property repeat repeat Property Property timing_repeat Polyline coordinates describing hotspot on the image Generalization Polyline coordinates describing hotspot on the image Generalization Polyline coordinates describing hotspot on the image Dependency Polyline coordinates describing hotspot on the image Dependency Polyline coordinates describing hotspot on the image codeSystem Property codeSystem Property codeSystem codeSystem Property Property code_codeSystem Polyline coordinates describing hotspot on the image Dependency Polyline coordinates describing hotspot on the image Generalization Polyline coordinates describing hotspot on the image Generalization Polyline coordinates describing hotspot on the image Generalization Polyline coordinates describing hotspot on the image Dependency Polyline coordinates describing hotspot on the image Dependency Polyline coordinates describing hotspot on the image Dependency Polyline coordinates describing hotspot on the image Generalization Polyline coordinates describing hotspot on the image Generalization Polyline coordinates describing hotspot on the image Generalization Polyline coordinates describing hotspot on the image reference name language expression description Expression telecom name ContactDetail url resource label kind document display citation RelatedArtifact Any upperLimit period origin lowerLimit factor dimensions data SampledData Comment Comment workflow venue user task species program gender focus age UsageContextType value kind UsageContext Comment wasValidated targetFormat sigFormat onBehalfOf data Signature dateTime comment author Annotation offset when timeOfDay dayOfWeek periodUnit periodMax period frequencyMax frequency durationUnit durationMax duration countMax count bounds Repeat event code Timing duration TimeInterval Comment url title size language hash dateCreated data contentType Image value CodeWithValue Unified Code for Units of Measure Country (ISO 3166-1) codeSystemVersion codeSystemName codeSystemId CodeSystem temp old official nickname maiden anonymous usual NameUse Comment comparator QuantityWithComparator mobile (Mobile (from FHIR)) old (Old (from FHIR)) temp (Temp (from FHIR)) WPN (Work Number) VHN (Vacation Home Number) PRS (Personal) PRN (Primary Residence Number) ORN (Other Residence Number) EMR (Emergency Number) ContactPointUse V (Vacation) SH (Shipping Address) S (Service Location) BR (Residence at birth) O (Office/Business (Work)) M (Mailing) L (Legal Address) H (Home Address) B (Firm/Business) F (Country Of Origin) BDL (Birth delivery location) N (Birth Address) BI (Billing Address) BA (Bad Address) AddressUse url phone fax email ContactPointSystem provinceOrTerritory CanadianMailingAddress denominator numerator Ratio nullFlavor value NullableBoolean value use system rank isTextMessageEnabled effectiveDateRange ContactPoint jurisdiction OtherCountryMailingAddress Unknown Unencoded Trace TemporarilyUnavailable SufficientQuantity PositiveInfinity NotAsked NotApplicable NoInformation NegativeInfinity Masked Invalid Derived AskedButUnknown NullFlavor stateOrTerritory UsMailingAddress unit TimeQuantity end start Period literal Decimal denominator numerator RateQuantity literal PointInTime high low Range unit value Quantity use initials suffix family given prefix effectiveDateRange PersonName unit MonetaryAmount postalCode country county city line3 line2 line1 use type text effectiveDateRange Address value system idType effectiveDateRange Id userSelected originalText nullFlavor displayText code Code

Properties:

View
NameDatatypesTypeClass Diagram