chore: add fhir document reference resource model

pkg/clinical/domain/document_reference.go

@@ -0,0 +1,154 @@
+package domain
+
+// FHIRDocumentReference represents a reference to a document of any kind for any purpose.
+// It provides metadata about the document so that the document can be discovered and managed.
+// The scope of a document is any seralized object with a mime-type, so includes formal patient centric documents (CDA), cliical notes, scanned paper, and non-patient centric documents like policy text.
+type FHIRDocumentReference struct {
+	ID                string                           `json:"id,omitempty"`
+	Meta              *FHIRMeta                        `json:"meta,omitempty"`
+	ImplicitRules     *string                          `json:"implicitRules,omitempty"`
+	Language          *string                          `json:"language,omitempty"`
+	Text              *FHIRNarrative                   `json:"text,omitempty"`
+	Extension         []FHIRExtension                  `json:"extension,omitempty"`
+	ModifierExtension []FHIRExtension                  `json:"modifierExtension,omitempty"`
+	MasterIdentifier  *FHIRIdentifier                  `json:"masterIdentifier,omitempty"`
+	Identifier        []FHIRIdentifier                 `json:"identifier,omitempty"`
+	Status            DocumentReferenceStatusEnum      `json:"status,omitempty"`
+	DocStatus         *CompositionStatusEnum           `json:"docStatus,omitempty"`
+	Type              *FHIRCodeableConcept             `json:"type,omitempty"`
+	Category          []FHIRCodeableConcept            `json:"category,omitempty"`
+	Subject           *FHIRReference                   `json:"subject,omitempty"`
+	Date              *string                          `json:"date,omitempty"`
+	Author            []FHIRReference                  `json:"author,omitempty"`
+	Authenticator     *FHIRReference                   `json:"authenticator,omitempty"`
+	Custodian         *FHIRReference                   `json:"custodian,omitempty"`
+	RelatesTo         []FHIRDocumentReferenceRelatesTo `json:"relatesTo,omitempty"`
+	Description       string                           `json:"description,omitempty"`
+	SecurityLabel     []FHIRCodeableConcept            `json:"securityLabel,omitempty"`
+	Content           []FHIRDocumentReferenceContent   `json:"content,omitempty"`
+	Context           *FHIRDocumentReferenceContext    `json:"context,omitempty"`
+}
+
+// FHIRDocumentReferenceRelatesTo specifies how this document reference is related to other resources,
+// such as being a replacement for, transformation of, or addition to another document reference.
+type FHIRDocumentReferenceRelatesTo struct {
+	ID                string                       `json:"id,omitempty"`
+	Extension         []Extension                  `json:"extension,omitempty"`
+	ModifierExtension []Extension                  `json:"modifierExtension,omitempty"`
+	Code              DocumentRelationshipTypeEnum `json:"code"`
+	Target            Reference                    `json:"target"`
+}
+
+// FHIRDocumentReferenceContent describes the content of the document, including the document itself as an attachment, and potentially its format.
+type FHIRDocumentReferenceContent struct {
+	ID                string         `json:"id,omitempty"`
+	Extension         []Extension    `json:"extension,omitempty"`
+	ModifierExtension []Extension    `json:"modifierExtension,omitempty"`
+	Attachment        FHIRAttachment `json:"attachment"`
+	Format            *FHIRCoding    `json:"format,omitempty"`
+}
+
+// FHIRDocumentReferenceContext provides the clinical context in which the document was created, such as encounter, period, practice setting.
+type FHIRDocumentReferenceContext struct {
+	ID                string                `json:"id,omitempty"`
+	Extension         []Extension           `json:"extension,omitempty"`
+	ModifierExtension []Extension           `json:"modifierExtension,omitempty"`
+	Encounter         []Reference           `json:"encounter,omitempty"`
+	Event             []FHIRCodeableConcept `json:"event,omitempty"`
+	Period            *FHIRPeriod           `json:"period,omitempty"`
+	FacilityType      *FHIRCodeableConcept  `json:"facilityType,omitempty"`
+	PracticeSetting   *FHIRCodeableConcept  `json:"practiceSetting,omitempty"`
+	SourcePatientInfo *Reference            `json:"sourcePatientInfo,omitempty"`
+	Related           []Reference           `json:"related,omitempty"`
+}
+
+// DocumentReferenceStatusEnum is a FHIR enum for document reference statuses
+type DocumentReferenceStatusEnum string
+
+const (
+	DocumentReferenceStatusEnumCurrent        DocumentReferenceStatusEnum = "current"
+	DocumentReferenceStatusEnumSuperseded     DocumentReferenceStatusEnum = "superseded"
+	DocumentReferenceStatusEnumEnteredInError DocumentReferenceStatusEnum = "entered-in-error"
+)
+
+// AllDocumentReferenceStatusEnum lists all document reference statuses
+var AllDocumentReferenceStatusEnum = []DocumentReferenceStatusEnum{
+	DocumentReferenceStatusEnumCurrent,
+	DocumentReferenceStatusEnumSuperseded,
+	DocumentReferenceStatusEnumEnteredInError,
+}
+
+// IsValid checks if the enum value is valid
+func (e DocumentReferenceStatusEnum) IsValid() bool {
+	switch e {
+	case DocumentReferenceStatusEnumCurrent, DocumentReferenceStatusEnumSuperseded, DocumentReferenceStatusEnumEnteredInError:
+		return true
+	}
+
+	return false
+}
+
+// String converts the enum to its string representation
+func (e DocumentReferenceStatusEnum) String() string {
+	return string(e)
+}
+
+// DocumentRelationshipTypeEnum is a FHIR enum for document relationship types
+type DocumentRelationshipTypeEnum string
+
+const (
+	DocumentRelationshipTypeEnumReplaces   DocumentRelationshipTypeEnum = "replaces"
+	DocumentRelationshipTypeEnumTransforms DocumentRelationshipTypeEnum = "transforms"
+	DocumentRelationshipTypeEnumSigns      DocumentRelationshipTypeEnum = "signs"
+	DocumentRelationshipTypeEnumAppends    DocumentRelationshipTypeEnum = "appends"
+)
+
+// AllDocumentRelationshipTypeEnum lists all document relationship types
+var AllDocumentRelationshipTypeEnum = []DocumentRelationshipTypeEnum{
+	DocumentRelationshipTypeEnumReplaces,
+	DocumentRelationshipTypeEnumTransforms,
+	DocumentRelationshipTypeEnumSigns,
+	DocumentRelationshipTypeEnumAppends,
+}
+
+// IsValid checks if the enum value is valid
+func (e DocumentRelationshipTypeEnum) IsValid() bool {
+	switch e {
+	case DocumentRelationshipTypeEnumReplaces, DocumentRelationshipTypeEnumTransforms, DocumentRelationshipTypeEnumSigns, DocumentRelationshipTypeEnumAppends:
+		return true
+	}
+
+	return false
+}
+
+// String converts the enum to its string representation
+func (e DocumentRelationshipTypeEnum) String() string {
+	return string(e)
+}
+
+// FHIRDocumentReferenceInput is the input type for FHIRDocumentReference
+type FHIRDocumentReferenceInput struct {
+	ID                string                           `json:"id,omitempty"`
+	Meta              *FHIRMetaInput                   `json:"meta,omitempty"`
+	ImplicitRules     *string                          `json:"implicitRules,omitempty"`
+	Language          *string                          `json:"language,omitempty"`
+	Text              *FHIRNarrativeInput              `json:"text,omitempty"`
+	Extension         []FHIRExtension                  `json:"extension,omitempty"`
+	ModifierExtension []FHIRExtension                  `json:"modifierExtension,omitempty"`
+	MasterIdentifier  *FHIRIdentifierInput             `json:"masterIdentifier,omitempty"`
+	Identifier        []FHIRIdentifierInput            `json:"identifier,omitempty"`
+	Status            DocumentReferenceStatusEnum      `json:"status,omitempty"`
+	DocStatus         *CompositionStatusEnum           `json:"docStatus,omitempty"`
+	Type              *FHIRCodeableConceptInput        `json:"type,omitempty"`
+	Category          []FHIRCodeableConceptInput       `json:"category,omitempty"`
+	Subject           *FHIRReferenceInput              `json:"subject,omitempty"`
+	Date              *string                          `json:"date,omitempty"`
+	Author            []FHIRReferenceInput             `json:"author,omitempty"`
+	Authenticator     *FHIRReferenceInput              `json:"authenticator,omitempty"`
+	Custodian         *FHIRReferenceInput              `json:"custodian,omitempty"`
+	RelatesTo         []FHIRDocumentReferenceRelatesTo `json:"relatesTo,omitempty"`
+	Description       string                           `json:"description,omitempty"`
+	SecurityLabel     []FHIRCodeableConceptInput       `json:"securityLabel,omitempty"`
+	Content           []FHIRDocumentReferenceContent   `json:"content,omitempty"`
+	Context           *FHIRDocumentReferenceContext    `json:"context,omitempty"`
+}