Repository navigation
PayloadBuilder
Ivan William Harsono edited this page Nov 17, 2026
·
2 revisions
Bahasa / Language: English · Bahasa Indonesia
One builder per resource — 141 in total, named <Resource>Builder in src/builder/.
from src.builder import PatientBuilder
from src.datatype.datatypes import Identifier, HumanName
patient = (
PatientBuilder()
.add_identifier(Identifier(system="https://fhir.kemkes.go.id/id/nik", value="3312345678901234", use="official"))
.add_name(HumanName(family="Sitorus", given=["John"], use="official"))
.set_gender("male")
.set_birth_date("1990-08-15")
.set_active(True)
.build()
)-
Python naming: methods are
snake_case(set_status,add_identifier), the class isPascalCase. -
Setters return
self, so calls chain;build()returns a plaindict. -
Empty values are dropped —
Noneand""never reach the payload, which is why a required field can be missing from a payload that looked complete in code. -
Data types are objects from
src.datatype.datatypes(33 classes);build()converts them throughto_array(). -
No validation. The builder never rejects input; the server decides, and
SSValidationErrorreads the answer. -
Three builders do not extend
BaseBuilder(BillingStatusBuilder,EndpointBuilder,PurificationDecisionBuilder) — they carry their ownset/pushhelpers. Same surface, different parent; keep that in mind when relying onisinstance. -
Seven builders target names that do not exist in FHIR R4 and are marked
not in R4below; a FHIR R4 server rejects those payloads.
Satu builder per resource — total 141, dinamai <Resource>Builder di src/builder/.
from src.builder import PatientBuilder
from src.datatype.datatypes import Identifier, HumanName
patient = (
PatientBuilder()
.add_identifier(Identifier(system="https://fhir.kemkes.go.id/id/nik", value="3312345678901234", use="official"))
.add_name(HumanName(family="Sitorus", given=["John"], use="official"))
.set_gender("male")
.set_birth_date("1990-08-15")
.set_active(True)
.build()
)-
Penamaan Python: metode
snake_case(set_status,add_identifier), kelasPascalCase. -
Setter mengembalikan
self, jadi bisa dirangkai;build()mengembalikandictbiasa. -
Nilai kosong dibuang —
Nonedan""tidak pernah sampai ke payload, karena itu field wajib bisa hilang dari payload yang terlihat lengkap di kode. -
Tipe data berupa objek dari
src.datatype.datatypes(33 kelas);build()mengonversinya lewatto_array(). -
Tanpa validasi. Builder tidak pernah menolak input; server yang memutuskan, dan
SSValidationErrormembaca jawabannya. -
Tiga builder tidak mewarisi
BaseBuilder(BillingStatusBuilder,EndpointBuilder,PurificationDecisionBuilder) — ketiganya membawaset/pushsendiri. Permukaan sama, induk berbeda; ingat itu saat mengandalkanisinstance. -
Tujuh builder menyasar nama yang tidak ada di FHIR R4 dan bertanda
not in R4di bawah; server FHIR R4 akan menolak payload tersebut.
| # | Resource | Builder | Sample methods | Spec |
|---|---|---|---|---|
| 1 | Account | AccountBuilder |
set_id(), set_status(), set_type() | R4 |
| 2 | ActivityDefinition | ActivityDefinitionBuilder |
set_id(), add_identifier(), set_status() | R4 |
| 3 | AdverseEvent | AdverseEventBuilder |
set_id(), add_identifier(), set_status() | R4 |
| 4 | AllergyIntolerance | AllergyIntoleranceBuilder |
add_identifier(), set_clinical_status(), set_verification_status() | R4 |
| 5 | Appointment | AppointmentBuilder |
set_id(), add_identifier(), set_status() | R4 |
| 6 | AppointmentResponse | AppointmentResponseBuilder |
set_id(), add_identifier(), set_status() | R4 |
| 7 | AuditEvent | AuditEventBuilder |
set_id(), add_identifier(), set_status() | R4 |
| 8 | Basic | BasicBuilder |
set_id(), add_identifier(), set_status() | R4 |
| 9 | BillingStatus | BillingStatusBuilder |
set_id(), add_identifier(), set_status() | not in R4 |
| 10 | Binary | BinaryBuilder |
set_id(), add_identifier(), set_status() | R4 |
| 11 | BiologicallyDerivedProduct | BiologicallyDerivedProductBuilder |
set_id(), add_identifier(), set_status() | R4 |
| 12 | BodyStructure | BodyStructureBuilder |
set_id(), add_identifier(), set_status() | R4 |
| 13 | Bundle | BundleBuilder |
set_type(), set_timestamp(), set_total() | R4 |
| 14 | CapabilityStatement | CapabilityStatementBuilder |
set_id(), add_identifier(), set_status() | R4 |
| 15 | CarePlan | CarePlanBuilder |
set_id(), set_status(), set_intent() | R4 |
| 16 | CareTeam | CareTeamBuilder |
set_id(), add_identifier(), set_status() | R4 |
| 17 | CatalogEntry | CatalogEntryBuilder |
set_id(), add_identifier(), set_status() | R4 |
| 18 | ChargeItem | ChargeItemBuilder |
set_id(), add_identifier(), set_status() | R4 |
| 19 | ChargeItemDefinition | ChargeItemDefinitionBuilder |
set_id(), add_identifier(), set_url() | R4 |
| 20 | ChargeItemResponse | ChargeItemResponseBuilder |
set_id(), add_identifier(), set_status() | not in R4 |
| 21 | Claim | ClaimBuilder |
set_id(), add_identifier(), set_status() | R4 |
| 22 | ClaimResponse | ClaimResponseBuilder |
set_id(), add_identifier(), set_status() | R4 |
| 23 | ClinicalImpression | ClinicalImpressionBuilder |
set_id(), add_identifier(), set_status() | R4 |
| 24 | Communication | CommunicationBuilder |
set_id(), add_identifier(), set_status() | R4 |
| 25 | CommunicationRequest | CommunicationRequestBuilder |
set_id(), add_identifier(), set_status() | R4 |
| 26 | Composition | CompositionBuilder |
set_id(), set_status(), set_type() | R4 |
| 27 | Condition | ConditionBuilder |
set_id(), add_identifier(), set_clinical_status() | R4 |
| 28 | Consent | ConsentBuilder |
set_id(), add_identifier(), set_status() | R4 |
| 29 | Contract | ContractBuilder |
set_id(), add_identifier(), set_status() | R4 |
| 30 | Coverage | CoverageBuilder |
set_id(), add_identifier(), set_status() | R4 |
| 31 | CoverageEligibilityRequest | CoverageEligibilityRequestBuilder |
set_id(), add_identifier(), set_status() | R4 |
| 32 | CoverageEligibilityResponse | CoverageEligibilityResponseBuilder |
set_id(), add_identifier(), set_status() | R4 |
| 33 | DetectedIssue | DetectedIssueBuilder |
set_id(), add_identifier(), set_status() | R4 |
| 34 | Device | DeviceBuilder |
set_id(), add_identifier(), set_status() | R4 |
| 35 | DeviceDefinition | DeviceDefinitionBuilder |
set_id(), add_identifier(), set_status() | R4 |
| 36 | DeviceMetric | DeviceMetricBuilder |
set_id(), add_identifier(), set_status() | R4 |
| 37 | DeviceRequest | DeviceRequestBuilder |
set_id(), add_identifier(), set_status() | R4 |
| 38 | DeviceUseStatement | DeviceUseStatementBuilder |
set_id(), add_identifier(), set_status() | R4 |
| 39 | DiagnosticReport | DiagnosticReportBuilder |
add_identifier(), set_status(), add_category() | R4 |
| 40 | DocumentManifest | DocumentManifestBuilder |
set_id(), add_identifier(), set_status() | R4 |
| 41 | DocumentReference | DocumentReferenceBuilder |
set_id(), set_status(), set_doc_status() | R4 |
| 42 | EffectEvidenceSynthesis | EffectEvidenceSynthesisBuilder |
set_id(), add_identifier(), set_status() | R4 |
| 43 | Encounter | EncounterBuilder |
add_identifier(), set_status(), set_class() | R4 |
| 44 | Endpoint | EndpointBuilder |
set_id(), add_identifier(), set_status() | R4 |
| 45 | EnrollmentRequest | EnrollmentRequestBuilder |
set_id(), add_identifier(), set_status() | R4 |
| 46 | EnrollmentResponse | EnrollmentResponseBuilder |
set_id(), add_identifier(), set_status() | R4 |
| 47 | EpisodeOfCare | EpisodeOfCareBuilder |
set_id(), add_identifier(), set_status() | R4 |
| 48 | EventDefinition | EventDefinitionBuilder |
set_id(), add_identifier(), set_status() | R4 |
| 49 | Evidence | EvidenceBuilder |
set_id(), add_identifier(), set_status() | R4 |
| 50 | EvidenceVariable | EvidenceVariableBuilder |
set_id(), add_identifier(), set_status() | R4 |
| 51 | ExampleScenario | ExampleScenarioBuilder |
set_id(), add_identifier(), set_status() | R4 |
| 52 | ExplanationOfBenefit | ExplanationOfBenefitBuilder |
set_id(), add_identifier(), set_status() | R4 |
| 53 | FamilyMemberHistory | FamilyMemberHistoryBuilder |
set_id(), add_identifier(), set_instantiates_canonical() | R4 |
| 54 | Flag | FlagBuilder |
set_id(), add_identifier(), set_status() | R4 |
| 55 | GenomicStudy | GenomicStudyBuilder |
set_meta_profile(), set_id(), add_identifier() | not in R4 |
| 56 | Goal | GoalBuilder |
set_id(), add_identifier(), set_lifecycle_status() | R4 |
| 57 | Group | GroupBuilder |
set_meta_profile(), set_id(), add_identifier() | R4 |
| 58 | GuidanceResponse | GuidanceResponseBuilder |
set_id(), add_identifier(), set_status() | R4 |
| 59 | HealthcareService | HealthcareServiceBuilder |
set_id(), add_identifier(), set_status() | R4 |
| 60 | ImagingManifest | ImagingManifestBuilder |
set_id(), add_identifier(), set_status() | not in R4 |
| 61 | ImagingSelection | ImagingSelectionBuilder |
set_id(), add_identifier(), set_status() | not in R4 |
| 62 | ImagingStudy | ImagingStudyBuilder |
set_id(), add_identifier(), set_status() | R4 |
| 63 | Immunization | ImmunizationBuilder |
set_id(), add_identifier(), set_meta_profile() | R4 |
| 64 | ImmunizationEvaluation | ImmunizationEvaluationBuilder |
set_id(), add_identifier(), set_status() | R4 |
| 65 | ImmunizationRecommendation | ImmunizationRecommendationBuilder |
set_id(), add_identifier(), set_status() | R4 |
| 66 | InsurancePlan | InsurancePlanBuilder |
set_id(), add_identifier(), set_status() | R4 |
| 67 | Invoice | InvoiceBuilder |
set_id(), add_identifier(), set_status() | R4 |
| 68 | Library | LibraryBuilder |
set_id(), add_identifier(), set_status() | R4 |
| 69 | Linkage | LinkageBuilder |
set_id(), add_identifier(), set_status() | R4 |
| 70 | List | ListResourceBuilder |
set_id(), add_identifier(), set_status() | R4 |
| 71 | Location | LocationBuilder |
add_identifier(), set_status(), set_name() | R4 |
| 72 | Measure | MeasureBuilder |
set_id(), add_identifier(), set_status() | R4 |
| 73 | MeasureReport | MeasureReportBuilder |
set_id(), add_identifier(), set_status() | R4 |
| 74 | Media | MediaBuilder |
set_id(), add_identifier(), set_status() | R4 |
| 75 | Medication | MedicationBuilder |
set_meta_profile(), set_id(), add_identifier() | R4 |
| 76 | MedicationAdministration | MedicationAdministrationBuilder |
set_id(), add_identifier(), set_medication_reference() | R4 |
| 77 | MedicationDispense | MedicationDispenseBuilder |
set_id(), add_identifier(), set_medication_reference() | R4 |
| 78 | MedicationKnowledge | MedicationKnowledgeBuilder |
set_id(), add_identifier(), set_status() | R4 |
| 79 | MedicationRequest | MedicationRequestBuilder |
set_id(), add_identifier(), add_category() | R4 |
| 80 | MedicationStatement | MedicationStatementBuilder |
set_id(), add_identifier(), set_status() | R4 |
| 81 | MedicinalProduct | MedicinalProductBuilder |
set_id(), add_identifier(), set_status() | R4 |
| 82 | MedicinalProductAuthorization | MedicinalProductAuthorizationBuilder |
set_id(), add_identifier(), set_status() | R4 |
| 83 | MedicinalProductContraindication | MedicinalProductContraindicationBuilder |
set_id(), add_identifier(), set_status() | R4 |
| 84 | MedicinalProductIndication | MedicinalProductIndicationBuilder |
set_id(), add_identifier(), set_status() | R4 |
| 85 | MedicinalProductIngredient | MedicinalProductIngredientBuilder |
set_id(), add_identifier(), set_status() | R4 |
| 86 | MedicinalProductInteraction | MedicinalProductInteractionBuilder |
set_id(), add_identifier(), set_status() | R4 |
| 87 | MedicinalProductManufactured | MedicinalProductManufacturedBuilder |
set_id(), add_identifier(), set_status() | R4 |
| 88 | MedicinalProductPackaged | MedicinalProductPackagedBuilder |
set_id(), add_identifier(), set_status() | R4 |
| 89 | MedicinalProductPharmaceutical | MedicinalProductPharmaceuticalBuilder |
set_id(), add_identifier(), set_status() | R4 |
| 90 | MedicinalProductUndesirableEffect | MedicinalProductUndesirableEffectBuilder |
set_id(), add_identifier(), set_status() | R4 |
| 91 | MessageDefinition | MessageDefinitionBuilder |
set_id(), add_identifier(), set_status() | R4 |
| 92 | MessageHeader | MessageHeaderBuilder |
set_id(), add_identifier(), set_status() | R4 |
| 93 | MolecularSequence | MolecularSequenceBuilder |
set_id(), set_type(), set_coordinate_system() | R4 |
| 94 | NutritionOrder | NutritionOrderBuilder |
set_id(), add_identifier(), set_status() | R4 |
| 95 | Observation | ObservationBuilder |
set_id(), add_identifier(), set_status() | R4 |
| 96 | ObservationDefinition | ObservationDefinitionBuilder |
set_id(), add_identifier(), set_status() | R4 |
| 97 | OperationOutcome | OperationOutcomeBuilder |
set_id(), add_identifier(), set_status() | R4 |
| 98 | Organization | OrganizationBuilder |
add_identifier(), set_name(), add_alias() | R4 |
| 99 | OrganizationAffiliation | OrganizationAffiliationBuilder |
set_id(), add_identifier(), set_status() | R4 |
| 100 | Patient | PatientBuilder |
add_identifier(), add_name(), add_telecom() | R4 |
| 101 | PaymentNotice | PaymentNoticeBuilder |
set_id(), add_identifier(), set_status() | R4 |
| 102 | PaymentReconciliation | PaymentReconciliationBuilder |
set_id(), add_identifier(), set_status() | R4 |
| 103 | Person | PersonBuilder |
set_id(), add_identifier(), set_status() | R4 |
| 104 | PlanDefinition | PlanDefinitionBuilder |
set_id(), add_identifier(), set_status() | R4 |
| 105 | Practitioner | PractitionerBuilder |
add_identifier(), add_name(), add_telecom() | R4 |
| 106 | PractitionerRole | PractitionerRoleBuilder |
set_id(), add_identifier(), set_active() | R4 |
| 107 | Procedure | ProcedureBuilder |
set_id(), add_identifier(), set_status() | R4 |
| 108 | Provenance | ProvenanceBuilder |
set_id(), add_identifier(), set_status() | R4 |
| 109 | PurificationDecision | PurificationDecisionBuilder |
set_id(), add_identifier(), set_status() | not in R4 |
| 110 | Questionnaire | QuestionnaireBuilder |
set_id(), add_identifier(), set_status() | R4 |
| 111 | QuestionnaireResponse | QuestionnaireResponseBuilder |
set_id(), set_status(), set_questionnaire() | R4 |
| 112 | RelatedPerson | RelatedPersonBuilder |
set_id(), add_identifier(), set_active() | R4 |
| 113 | RequestGroup | RequestGroupBuilder |
set_id(), add_identifier(), set_status() | R4 |
| 114 | ResearchDefinition | ResearchDefinitionBuilder |
set_id(), add_identifier(), set_status() | R4 |
| 115 | ResearchElementDefinition | ResearchElementDefinitionBuilder |
set_id(), add_identifier(), set_status() | R4 |
| 116 | ResearchStudy | ResearchStudyBuilder |
set_id(), add_identifier(), set_status() | R4 |
| 117 | ResearchSubject | ResearchSubjectBuilder |
set_id(), add_identifier(), set_status() | R4 |
| 118 | ResourceGuide | ResourceGuideBuilder |
set_id(), add_identifier(), set_status() | not in R4 |
| 119 | RiskAssessment | RiskAssessmentBuilder |
set_id(), set_status(), set_subject() | R4 |
| 120 | RiskEvidenceSynthesis | RiskEvidenceSynthesisBuilder |
set_id(), add_identifier(), set_status() | R4 |
| 121 | Schedule | ScheduleBuilder |
set_id(), add_identifier(), set_status() | R4 |
| 122 | SearchParameter | SearchParameterBuilder |
set_id(), add_identifier(), set_status() | R4 |
| 123 | ServiceRequest | ServiceRequestBuilder |
set_id(), add_identifier(), set_requisition() | R4 |
| 124 | Slot | SlotBuilder |
set_id(), add_identifier(), set_status() | R4 |
| 125 | Specimen | SpecimenBuilder |
set_id(), add_identifier(), set_status() | R4 |
| 126 | SpecimenDefinition | SpecimenDefinitionBuilder |
set_id(), add_identifier(), set_status() | R4 |
| 127 | Subscription | SubscriptionBuilder |
set_id(), add_identifier(), set_status() | R4 |
| 128 | Substance | SubstanceBuilder |
set_id(), set_status(), set_code() | R4 |
| 129 | SubstanceNucleicAcid | SubstanceNucleicAcidBuilder |
set_id(), add_identifier(), set_status() | R4 |
| 130 | SubstancePolymer | SubstancePolymerBuilder |
set_id(), add_identifier(), set_status() | R4 |
| 131 | SubstanceProtein | SubstanceProteinBuilder |
set_id(), add_identifier(), set_status() | R4 |
| 132 | SubstanceReferenceInformation | SubstanceReferenceInformationBuilder |
set_id(), add_identifier(), set_status() | R4 |
| 133 | SubstanceSourceMaterial | SubstanceSourceMaterialBuilder |
set_id(), add_identifier(), set_status() | R4 |
| 134 | SubstanceSpecification | SubstanceSpecificationBuilder |
set_id(), add_identifier(), set_status() | R4 |
| 135 | SupplyDelivery | SupplyDeliveryBuilder |
set_id(), add_identifier(), set_status() | R4 |
| 136 | SupplyRequest | SupplyRequestBuilder |
set_id(), add_identifier(), set_status() | R4 |
| 137 | Task | TaskBuilder |
set_id(), add_identifier(), set_instantiates_canonical() | R4 |
| 138 | TestReport | TestReportBuilder |
set_id(), add_identifier(), set_status() | R4 |
| 139 | TestScript | TestScriptBuilder |
set_id(), add_identifier(), set_status() | R4 |
| 140 | VerificationResult | VerificationResultBuilder |
set_id(), add_identifier(), set_status() | R4 |
| 141 | VisionPrescription | VisionPrescriptionBuilder |
set_id(), add_identifier(), set_status() | R4 |