Mapping

scope	Name	Type	Value / mapping

scope	Name	Type	Value / mapping
formal sector	`identifier`[0]	type.coding.code “UUID“ Reference: Contract	UUID of contract
informal sector	`identifier`[0]	type.coding.code “UUID“ Reference: Contract	UUID of policy
all	`legalState`	String	NEW = N => “Offered“, RENEWED = R => “Renewed“
formal sector (optional)	`signer.party` [0].`identifier`	type.coding.code “UUID“ Reference: Person / Patient	user that approve
formal sector (optional)	`signer.party` [1].`identifier`	type.coding.code “UUID“ Reference: Person / Patient	PH user that submitted
informal sector (mandatory)	`signer.party` [0].`identifier`	type.coding.code “UUID“ Reference: Practitioner	value:EnrolmentOfficer UUID text (optional): EnrolmentOfficer
informal sector (optional)	`signer.party` [1].`identifier`	type.coding.code “UUID“ Reference: Patient	value:Head of Family UUID text (optional): HeadOfFamily
all	`status`	String	STATUS_IDLE = 1 => “Offered“ STATUS_ACTIVE = 2 => “Executed“ STATUS_SUSPENDED = 4 => “Disputed“ STATUS_EXPIRED = 8 => “Terminated“ STATUS_READY = 16 => “Executable“ STATUS_CONTRACTED(Those are FS contract)
1 `term`element for informal, multiple possible for formal sector	`term`[0].`asset`.`context`	Array of: `code` “Dependant“ or “Insuree“ Reference: Patient Reference.type.coding.code: “UUID“	UUID of the Patient
formal sector	`term`[0].`asset`.identifier	identifier	Contract details UUID
1 `term`element for informal, multiple possible for formal sector	`term`[0].`asset`.`period`	Period	Policy Start / expiry
1 `term`element for informal, multiple possible for formal sector	`term`[0].`asset`.`usePeriod`	Period	Policy effective_start/ expiry
Depreciated	`term`[0].`asset`.`typeReference` [OLD, should be replaced]	Array of: Type: InsuranceProduct Indentifiertype.coding.code: “UUID“	UUID of the product
1 `valuedItem`element per terms for informal, multiple possible for formal sector	`term`[0].`asset`.valuedItem[0].entity.entityReference	identifier.type.coding.code: “UUID“ type: “InsuranceProduct”	UUID of the product
Formal sector	`term`[0].`asset`.valuedItem[0].identifier	identifier	UUID of the contractcontributionplandetails
future	`term`[0].`asset`.valuedItem[0].unitPrice	Money	PolicyValue before discount
future	`term`[0].`asset`.valuedItem[0].factor	decimal	discount if any
all	`term`[0].`asset`.valuedItem[0].net	Money	PolicyValue
formal sector	`term`[0].`asset`.valuedItem[0].linkId	string	Link to Coverage (policy)
deprecated	`term`[0].`asset`.`value`		Total of contract Policy value

Endpoint specification

Example of endpoint URL

http://localhost:8000/api_fhir_r4/Contract/

Supported HTTP operation

READ - GET HTTP method

By default, returns the list of all available contract resources. To fetch information about a specific object, you should add the UUID (e.g.02EEC-436C-495F-862U2-6FF68644D751) key to URL :

http://localhost:8000/api_fhir_r4/Contract/02EEC-436C-495F-862U2-6FF68644D751

Should be used the GET HTTP method.

PUT - the operation currently supported

Updates the value of the specific object. List of supported fields can be found in the mapping table. Should be used the PUT HTTP method and the body as JSON representation (example can be found below). The requested URL needs to point to a specific object to do that you should add the UUID (e.g. 02EEC-436C-495F-862U2-6FF68644D751) key to URL for instance:

http://localhost:8000/api_fhir_r4/Contract/02EEC-436C-495F-862U2-6FF68644D751

DELETE - the operation currently not supported

The operation can be used to remove the specific object from the database. Should be used the DELETE HTTP method. The requested URL needs to point to a specific object to do that you should add the UUID (e.g. 02EEC-436C-495F-862U2-6FF68644D751) key to URL for instance:

http://localhost:8000/api_fhir_r4/Contract/02EEC-436C-495F-862U2-6FF68644D751

The DELETE operation will permanently remove the row from the database.

openIMIS

FHIR R4 Contract

Mapping

Endpoint specification

Example of endpoint URL

Supported HTTP operation

READ - GET HTTP method

Example

Did you encounter a problem or do you have a suggestion?

Please contact our Service Desk