FHIR SDK（DotNet）- Resource Type - Complex (Patient)

Patient這個Resource是FHIR應用中最常碰到的（另一個是Encounter）。他的結構夠複雜，可以涵蓋許多面向。

如圖中用紅框所示。一個是Choice Type，另一個是BackboneElement。

Choice要注意的是他可能會有不同的資料型態，而且要注意Tag名稱的變化。

BackboneElement他是繼承Element的類別。屬於此資料型態者，就表示會有自己專屬的Element。

而這兩個東西，是跟著所屬的Resource，不可共享。注意，有些地方名稱會一樣，但實際內容是不同的。（有規則就有例外，有部份BackboneElement是參考同一個Resource其他Path下的相同結構的BackboneElement，可參考ImplementationGuide的page）

在程式中這兩個傢伙就得小心處理。

原則上，欄位宣告這些都沒有特別差異。僅需注意紅框是為了Choice Type，而白框是為了BackboneElement。注意參照型態的類別名稱並不會影響JSON內容的判讀。

====Choice Type=====

 

他繼承了ChoiceType，要把自己的element name送給父類別，並且把可選擇的資料型態也定義好即可。(再強調一下，這些內容都是程式產生的)

=====BackboneElement=====

看到這，咦！不就是Complex Type嗎？對呀就是扣除Primity Type＋Element那段亂流之外，其實所有結構都是對應到類別呀。為了共用程式碼所以繼承了BackboneElementType<T>，這類別就是繼承了BackboneElement。

所以，全劇終。（但～還是有陷阱）

FHIR SDK（DotNet）- Resource Type - Simple (Basic)

Basic這個Resouce是神奇的存在著。他沒什麼用途，但每次開發系統，一定會先拿他來測試。這裡當然不例外，可惜他真的太單純，無法涵蓋所有面向。

這個Resource沒什麼特殊性，就跟Complex Type一樣，就是有一堆欄位，因繼承DomainResource，所以還會多一些欄位。

所以，程式的部份也沒有什麼特殊性，也就跟ComplexType差不多，只是這邊繼承了ResourceType<T>（上篇已介紹），而不是DomainResource。這是為了拉出實做共同性。這邊的OnPropertyChanged是Resource系列自己的，就不是用DataType那邊的。還有[0..*]是用了List<T>這個資料型態。因為(1) 使用 reflection機制，(2) 要抓JsonArray，幾經實驗，用這個最保險。

這個版本的SDK還沒有把Binding機制做上去，坦白說，還不知道怎麼處理。

另外Reference也沒有把Resource限制進行處理。其實在應用沒有什麼影響。除非是要搞驗證，就需要補上。

=========
透露一下，這裡面的程式碼，都是用另一個專案產生的。這又是另一個技術門檻。

FHIR SDK（DotNet）- FHIR Type Framework - Resource

Resource系列雖然可視為Complex Type，但仍須獨立視之，否則到處都是地雷。在其他的Resource，例如Bundle，其元素entry/resource的資料型態就是Resource。但Resource是抽象型態(Abstract Class)，在C#中是不能產生實例。這塊就是得想辦法克服之處。

Resource直接繼承了Base，其所含的元素，乍看之下沒有什麼特殊性。比較麻煩的是meta，他的資料型態是Meta。Meta繼承DataType，所以，他沒有Extension機制。

那Extension機制呢？哈～怎麼可能遺漏呢？原來是放在了DomainResource，而且一次給妳兩個，extension與modifierExtension。（這兩者差異不在本系列範疇）。contained的資料型態是Resource，是他的父類別。這個問題不大，這個類別沒有特別要處理的。

至於其子類別CanonicalResource與在下一個子類別MetadataResource，這兩個定義是介面，表示某些類別需要實做這兩個。例如ActiveDefinition在其結構描述中就有指定要實做MetadataResource。在這兩個介面描述就會說明實做資源相對應條件要求。這塊SDK並沒有實做。

===============

Resource類別的設計與Complex Type類似，只是OnPropertyChange與SetupPropertyValue需要另外處理。(因為Resource直接繼承了base，而這些功能不能寫在Base，因為Datatype那邊有個Element，處理方式略有不同。)

DomainResource更簡單，就是單純的ComplexType。

之前也說過，Resource 是抽象類別，無法直接產生實例。所以，透過可實做類別來實現之。多一個ResourceType類別，硬是把所有Resource都變成Complex Type一樣的操作方式。

FHIR SDK（DotNet）- FHIR Type Framework - BackboneType, BackboneElement

 在Base Type的Element這邊系列中，長了兩個很奇怪的類別BackboneElement繼承了Element，而BackboneType繼承了DataType，兩個類別的欄位內容卻一模一樣。這到底是怎麼一回事呢？

這個設計很明顯就是為了實踐FHIR所強調的20-80理論，但也苦了實做者。

先來看這張圖：

=====BackboneType=====

原來BackboneType其實就是為了幾個Complex Type擁有modifierExtension的機制。有哪幾個呢？依據文件，目前(是的，只能說目前，未來還是有可能增加)Timing、Dosage與ElementDefinition這三個DataType。注意了，我拿Address與Timing來比對。

文件中，兩者都是繼承了Element。所有的Complex Type都是寫繼承Element，沒有DataType。僅能從描述中得知Timing繼承了一個modifierExtension的屬性。這個程式碼單純，就是ComplexType的一種。就不多做解釋了。

=====BackboneElement=====

一定很好奇，除了Base Types的圖中有看到BackboneElement之外，他到底在哪裡呢？原來，他在Resource那邊。找個大家熟悉的Patient Resource吧。

原來他也是一種DataType，但是，他僅是抽象類別，實際的內容還是要看此Elmenet之下的宣告。有感應到了嗎？原則上所有的資料型態都會有extension，但是這類BackboneElement的類別，還會多了modifierExtension。(與BackboneType給的邏輯不太相同)。

BackboneElement的設計架構非常複雜。首先，他會有一個抽象類別，就跟BackboneType一樣，要有modifierExtension屬性。

而分散在Resource裡的BackboneElement，其結構每一個都不一樣。所以，得為每一個不同的BackboneElement設計共用父類別，而這個父類別必須走Reflect架構，這樣子才能夠因應不同的BackboneElement。這個類別的程式非常複雜，也不好解釋。有緣再說了。

來看一下Resource類別是怎麼設計的。仍以Patient Resource為例。

Resource本身當然是繼承了ResourceType系列，這部份後續才會說明。

而Patient Resource裡面的BackboneElement必須帶入類別，這樣子才會知道有哪些欄位屬性，這才方便進行後續處理。

補充說明一下：這個Resource類別的產生，是另一個專案用T4技術自動化產生。這塊技術也是有緣再說明吧。(哈～畢竟一路走來，都是自言自語比較多)

FHIR SDK（DotNet）- FHIR Type Framework - Choice Type

Choice Type是個美麗又邪惡的小女孩，她的彈性是種讓你無法承受的愛。想在密密麻麻的文件中尋得他的蹤跡，是件苦差事。當你揭開她的神秘面紗，你一定會深深的愛上他。

上一篇已經提到Choice Type 是該面對他的時候。

想要深入瞭解他，得從Extension這個資料型態的文件去瞭解他。

這個value[x] ，尤其是Type欄位的*，她帶著什麼樣的神秘事件呢？

他的意思是說，Extension有欄位叫value，他可以任意一種資料型態。能有多任意呢？以下的都可以。

• valueBase64Binary: base64Binary
• valueBoolean: boolean
• valueCanonical: canonical
• valueCode: code (only if the extension definition provides a fixed binding to a suitable set of codes)
• valueDate: date
• valueDateTime: dateTime
• valueDecimal: decimal
• valueId: id
• valueInstant: instant
• valueInteger: integer
• valueInteger64: integer64
• valueMarkdown: markdown
• valueOid: oid
• valuePositiveInt: positiveInt
• valueString: string
• valueTime: time
• valueUnsignedInt: unsignedInt
• valueUri: uri
• valueUrl: url
• valueUuid: uuid
• valueAddress: Address
• valueAge: Age
• valueAnnotation: Annotation
• valueAttachment: Attachment
• valueCodeableConcept: CodeableConcept
• valueCodeableReference: CodeableReference
• valueCoding: Coding
• valueContactPoint: ContactPoint
• valueCount: Count
• valueDistance: Distance
• valueDuration: Duration
• valueHumanName: HumanName
• valueIdentifier: Identifier
• valueMoney: Money
• valuePeriod: Period
• valueQuantity: Quantity
• valueRange: Range
• valueRatio: Ratio
• valueRatioRange: RatioRange
• valueReference: Reference - a reference to another resource
• valueSampledData: SampledData
• valueSignature: Signature
• valueTiming: Timing
• valueContactDetail: ContactDetail
• valueDataRequirement: DataRequirement
• valueExpression: Expression
• valueParameterDefinition: ParameterDefinition
• valueRelatedArtifact: RelatedArtifact
• valueTriggerDefinition: TriggerDefinition
• valueUsageContext: UsageContext
• valueAvailability: Availability
• valueExtendedContactDetail: ExtendedContactDetail
• valueDosage: Dosage
• valueMeta: Meta

有注意到了嗎？在JSON中，他的Tag Name（key） 是（欄位名稱+資料型態名稱）而資料型態名稱還得首字大寫。
其他資料型態也有此Choice Type的有Timing的repeat（這是個詭異結構）與Annotation。

謝天謝地，這兩個的Choice Type有限定資料型態。

Choice Type大部份都是出現在Resource中，還好解法皆相同。

==========

程式解法很單純，提供一個ChoiceType當父類別，來處理一切雜事。提供各種情境的建構元。

接著就是複寫來自DataType的函數與實做介面。

這時候，74: IsChoiceType()就得設成true了。

其他最重要的就是88:與89:這兩行。

89:宣告一個抽象函數，讓子類別來告訴父類別，目前這個Choice Type限定哪些資料型態。

88:然後有了GetSupportDataType()這個函數讓建構元來使用，確保抓到屬於這個Choice Type該有的Tag。

這就是子類別的樣子，其實差異只在於SupportType而已。

FHIR SDK（DotNet）- FHIR Type Framework - Complex Type - 3

也許應該要感謝DotNet平台提供了Reflection機制，讓程式結構可以做到簡化，但要能發揮他的功效，需要抽象概念轉換，吃了不少苦頭。

=====SetupPropertyValue=====

54-55：首先要先取得這個Complex有哪些欄位。還記得這個T是在宣告類別時，從子類別定義來的。

56-143：就是分別對這個欄位進行資料轉換作業。因為欄位的性質不同，處理的方式也就要不同。

58-60：先把來源資料與欄位關係確立好。

63：順便把可能是Primitie Element那塊的json資料Key準備好。

64-103：如果這個欄位定義為[0..*]時；在類別宣告上，當為多時都用List<T>。

66：得先知道這個多的欄位他的資訊型態是什麼？

68-84：如果是Choice Type，那就走Choice Type流程。

85-102：如果是Complex或Primitive的話，就走這邊。奇怪，這邊怎們不分開處理？因為是多，逐一執行時，還是會回到單一一筆的流程，那邊就會分了。

106-141：如果欄位宣告是[0..1]時。就依據資料型態個別處理吧。

=====SetupJsonObject=====

就根據欄位產生JsonObject，其中SetupPropertyValue函數也是用到Reflection，這邊就不贅述了。

FHIR SDK（DotNet）- FHIR Type Framework - Complex Type - 2

雖然Complex Type有很多，但他們的行為模式都是一樣，設計一個父類別來處理。等等，不是有最討厭的Element嗎？這邊可以放心，因為Complex對應回JSON就是一個物件結構，id與extension就如同其他欄位一樣的自然存在。

宣告ComplexType<T>，用到泛型，T就是哪些有宣告欄位的Complex Type們。建構元也很簡單，就是把傳進來的值進行解析，然後去更新所有的欄位內容值。在此是呼叫SetupPropertyValue()這個函數。（有點複雜，容後說明）

接著複寫來自DataType的函數。應該可以理解，目前IsCompelx()就得設成true了。另外，取得JsonString的部份，用了C# Extension Method機制，將JsonNode，多了產生JSON String 的方法。（為何多此一舉？唉～那就要問微軟了，他的DotNet的問題）

再來實做來自IComplexType的介面要求，而且是非常重要的函數服務GetJsonObject()。因為SDK其實是用Key-Value來存放JSON內容。Value的部份實際上是用JsonNode。身為Complex Type他一定是在Value這端，所以，這個函數很重要。把Key-Value轉成JsonNode出來。

因為Complex的欄位，也有可能是JsonValue、JsonObject或JsonArray，還好他們有共同父類別是JsonNode。只是要注意，這套程式庫，會咬死Json Path，不能輕易把一段JSON掛到某一個Element上，所以要用DeepClone()這個方法，來取得乾淨的JsonNode結構。

另外，還有一種情境，這個Complex是用new() {}然後設值的方式建構的，也就是說沒有經過建構元，那就不會建立啟始的_Properties內容，此時，就得透過SetupJsonObject()方式，來取得各欄位內容值，再轉換成JsonNode。

==========

SetupPropertyValue()是支援建構元，將JsonNode資料轉換成Complex 物件。

SetupJsonObject()是將Complex物件的內容轉換成JsonNode。

這兩個東西是整個SDK第二困難與複雜的點。就留待下篇來說明。

FHIR SDK（DotNet）- FHIR Type Framework - Complex Type - 1

 Complex Type這個字眼在R3之後，就不存在了，但我還是習慣用這個字眼。他代表著參考型態，是一堆欄位組合類別。現在是分成了General-Purpose DataTypes、Metadata Types與Special Purpose Datatypes。

目前SDK規劃了22個，未來應該還會增加，畢竟這塊FHIR也沒有穩定下來。

先舉個最簡單的範例Coding，下圖是其結構。

他繼承了Element，所以會有id與extension。（實際上他應該是繼承DataType，但他是空的，而FHIR文件都習慣寫繼承於Element）

他有五個欄位，所幸，所有欄位的資料型態都是Primitive。

其程式結構如下圖。

7: 他繼承了ComplexType<T>，其實所有Complex Type除了欄位結構不同外，所有行為模式都是一樣的。

9-13: 宣告Coding所用的欄位，其資料型態都是Primitive。

14-22: 公開屬性可以取值與設值。要注意的是20，他定義了當有屬性內容值變更時，要去呼叫OnPropertyChanged函數，目的是要去更新放在Base類別的_Properties屬性的內容。

23-51: 其他欄位的處理方式跟前者一樣。

60-62: 是建構元，原則上都是丟給父類別來處理。

看過Coding，應該會想到那CodeableConcept是長什麼樣子。其實，架構對了，都是同樣的處理手法。

FHIR SDK（DotNet）- FHIR Type Framework - Primitive Type - 2

 雖然Primitive Type號稱有20個，除了對應回程式語言的資料型態不同與Regex不同外，其實他的行為模式是高度一致的。所以，設計一個PrimitiveType<T1, T2>類別來處理所有雜事。

類別定義，用到了泛型。T1是指FHIR的資料型態，當然這些傢伙都是繼承了DataType。T2是指程式語言的資料型態。

這邊宣告了三個屬性。第一個屬性是此Primitive Type的字串型態的值。所有的值都可以被轉換成string。放這個，可以任意轉換成其他資料型態(如果可以轉的話)。

第二個是這個Primitive Type所擁有的Element內容。預設值為null。

第三個是這個Primitive Type所對應程式語言資料型態的值。

這是建構元的部份，其實就是接收外部宣告值來建立此物件的初始值。20個Primitive Type實際上都是交付到這兒來實做。其中protected PrimitiveType(JsonNode? value, string? elementName)這個非常重要。他是用來判斷接受到的JSON內容是單純的value嗎？那簡單就是落實在Primitive原始範疇內。如果不是，給的是物件，那就得交付 InitElementObject((JsonObject)value, elementName)這個私有函數來處理了。（最後說明）

也許最後幾行有點奇怪，不是說_elementValue是放Element嗎？怎麼冒出Id與Extension。別忘了這個類別繼承了DataType，而DataType繼承了Element，所以自然有這兩個欄位。

這兒是複寫遺留自DataType的函數。

因為從這兒開始都是Primitive，所以IsPrimitive()當然要設成true，其他兩個是false。

再來就是ToJsonString，依據JSON的要求，只有String與DateTime資料型態其值需要加引號，其他不用。特別提醒一下，這邊只需要注意Value的部份，至於Key是什麼，就是得看Complex Type或Resource的Element的名稱。

接著就是要實做Interface的部份，列出函數清單提供參考。

最後來說明一下 InitElementObject((JsonObject value, string elementName)這個私有函數，是用來處理Primitive Type卻收到JsonObject內容，那就表示我們拿到了Element。

124：我們要找的element名稱其實是前面有"_"者。

125-128：先把正常的Value先取走。

129-149：取Element的部份。注意，這段程式不會是一開始就能寫的。因為extension欄位的資料型態是Extension，他是屬於Complex Type，都還沒動到那邊。

FHIR SDK（DotNet）- FHIR Type Framework - Primitive Type - 1

Primitive Type是一切神奇的開始， 是FHIR與程式語言交握之處，是一切基石。設計的核心在於能夠適應FHIR後續建構需求之發展，更需要能夠落實於程式語言之實做。

就其FHIR結構而言，是如此的單薄無力，但他卻承擔著20個Primitive Type的實做意義。

首先我們遭遇到的問題是FHIR資料型態的名稱就是跟程式語言的資料型態名稱相衝突。為了讓實做保持一致性，所以，上述20個資料型態的名稱全部加上了Fhir。（實際上是21個，因為Xhtml也屬於）

雖然有21個，其實就是分成字串類與數值類兩種。而真正的分法其實是JSON的Value部份要不要加引號的問題。也就是說，要從JSON角度出發，想想這21個資料型態應對應回程式語言什麼樣的資料型態。

另外，還要思考Null值的Value要怎麼辦。所以，另外設計的一系列Inteface來要求此21個資料型態是怎麼對應回程式語言的資料型態。

舉個FhirString這個Primitive Type為例，他需要實做IStringValue，而實際上他的Value值是對應回程式語言的string。

FhirString也繼承了PrimitiveType<T1, T2>，這個應用到泛型，也就是把這21個資料型態共通性的實做放到了父類別，並且告知FHIR資料型態與對應的程式型態。這個父類別就留待下一篇說明。

另外再舉一個FhirInteger為例，他需要實做IInteger32Value，他是對應為程式語言的int資料型態。一樣繼承PrimitiveType<FhirInteger, int>。

因為C#的string有支援null而int沒有，所以，這邊有多一個HasValue屬性。這是來自IInteger32Value的介面要求。

建構式的部份除了接收JsonNode的之外，都一定會接收string。再來就是接收對應於程式語言的資料型態。

至於討人厭的Element，為避免破壞Primitive的單純性，將其拉出單獨處理之。

再者是驗證，這是依據FHIR官方文件所提供的Regex。

另外要提供的事GetJsonValue()函數，注意Primitive不要理會Element的話，在JSON的角度，他就是Key-value，而這個value的就是一個純數。那有Element怎麼辦。根據官方文件，這個key的名稱，會多一個"_"，這也是我設計決策上，要把他獨立的原因。

其實這21個Primitive Type，沒有什麼，真正的神奇魔法是在PrimitiveType<T1, T2>這個類別。

FHIR SDK（DotNet）- FHIR Type Framework - DataType

雖然DataType看起來是個不起眼的類別，但他卻扮演著摩西分海的重要角色。因為，在他之下，會有Primitive、Complex與Choice三種類型，而這三種類型處理方式皆不同。

DataType是抽象類別，繼承Element，就有了id與extension這兩個屬性。也就是說繼承於DataType的也有。講白了Primitive也有，這就破壞了Primitive的定義。講到Primitive時再深入說明。

另外，應該有注意到，在Type Framework圖中，並沒有看到Complex與Choice呀，是的這兩個沒有，再看這張圖，除了繼承於PrimitiveType的都算是Complex Type。

在這邊就必須要有個設計決策。其他的類別跟Primitive Type都是繼承了DataType，但其他類別的性質真的跟Primitive不同，若把其他類別的實做放在DataType，就會影響到Primitive Type。為了避免這樣子的情形，就得為其他的類別創立一個父類別，稱之為Complex Type 繼承於DataType。其他類別共通性實做，就放在Complex Type上，避開影響Primitive Type。

另外新增一個Choice類別，他也不在這個FHIR Type Framework上，因為他可能組合了Primitive與Complex，所以，為了實做也要多一個Choice。

程式結構如下：

另外，為了區隔DataType的Element實做差異性，這邊的建構元，並沒有繼承於父類別。而這邊的建構元只是讓各類別格式相同，其實，真正建構元都分散在Primitive、Complex與Choice。