Skip to content

HeyDonto FHIR R4 API Documentation (1.0)

API documentation for HeyDonto API users

Powered by HeyDonto
Overview
Languages
Servers
Mock server

https://docs.heydonto.com/_mock/apis/fhir/openapi/

Sandbox

https://api-staging.heydonto.com/

Production

https://api.heydonto.com/

Account

Operations

ActivityDefinition

Operations

AdverseEvent

Operations

AllergyIntolerance

Operations

Appointment

Operations

AppointmentResponse

Operations

AuditEvent

Operations

Basic

Operations

Binary

Operations

BiologicallyDerivedProduct

Operations

BodyStructure

Operations

Bundle

Operations

CapabilityStatement

Operations

CarePlan

Operations

CareTeam

Operations

CatalogEntry

Operations

ChargeItem

Operations

ChargeItemDefinition

Operations

Claim

Operations

ClaimResponse

Operations

ClinicalImpression

Operations

CodeSystem

Operations

Communication

Operations

CommunicationRequest

Operations

CompartmentDefinition

Operations

Composition

Operations

ConceptMap

Operations

Condition

Operations

Contract

Operations

Coverage

Operations

CoverageEligibilityRequest

Operations

CoverageEligibilityResponse

Operations

DetectedIssue

Operations

Device

Operations

DeviceDefinition

Operations

DeviceMetric

Operations

DeviceRequest

Operations

DeviceUseStatement

Operations

DiagnosticReport

Operations

DocumentManifest

Operations

DocumentReference

Operations

EffectEvidenceSynthesis

Operations

Encounter

Operations

Endpoint

Operations

EnrollmentRequest

Operations

EnrollmentResponse

Operations

EpisodeOfCare

Operations

EventDefinition

Operations

Evidence

Operations

EvidenceVariable

Operations

ExampleScenario

Operations

ExplanationOfBenefit

Operations

FamilyMemberHistory

Operations

Get FHIR r4 family member historys

Request

Security
bearer or bearer
Path
siteIdstringrequired

Site identifier

Query
_countnumber

Number of items to return (default=20).

Example: _count=10
_page_tokenstring

Token for fetching the next page of results.

Example: _page_token=CgYK...
_sortstring

Sort the results by a given field, e.g. _sort=family or _sort=-date.

Example: _sort=family
_elementsstring

Restrict returned fields, e.g. _elements=identifier,name.

Example: _elements=identifier,name
telecomstring

Filter by resource telecom, e.g. date=[SYSTEM]|[VALUE].

Example: telecom=telecom=phone|555-555-5555
_idstring

Search for a specific resource by ID, e.g. _id=abc123.

Example: _id=abc123
identifierstring

Search for resources by identifier token, e.g. identifier=http://hospital.org|12345.

Example: identifier=http://hospital.org|12345
_includestring

Include related resources, e.g. _include=Appointment:patient.

Example: _include=Appointment:patient
patientstring

Include related patient resources, e.g. patient=Patient/[id]&.

Example: patient=patient=Patient/[id]&
_revincludestring

Reverse include related resources, e.g. _revinclude=Observation:subject.

Example: _revinclude=Observation:subject
_hasstring

Reverse chaining, e.g. _has:Observation:subject:code=http://loinc.org|1234-5.

Example: _has=Observation:subject:code=http://loinc.org|1234-5
_tagstring

Search by tag on the resource meta, e.g. _tag=http://example.org/tags|sample-tag.

Example: _tag=http://example.org/tags|sample-tag
_securitystring

Search by security label on resource meta, e.g. _security=RBAC|CONFIDENTIAL.

Example: _security=RBAC|CONFIDENTIAL
_profilestring

Search by profile in resource meta, e.g. _profile=http://example.org/fhir/StructureDefinition/custom-profile.

Example: _profile=http://example.org/fhir/StructureDefinition/custom-profile
curl -i -X GET \
  'https://docs.heydonto.com/_mock/apis/fhir/openapi/site/{siteId}/fhir/family-member-history?_count=10&_page_token=CgYK...&_sort=family&_elements=identifier%2Cname&telecom=telecom%3Dphone%2C555-555-5555&_id=abc123&identifier=http%3A%2F%2Fhospital.org%2C12345&_include=Appointment%3Apatient&patient=patient%3DPatient%2F%5Bid%5D%26&_revinclude=Observation%3Asubject&_has=Observation%3Asubject%3Acode%3Dhttp%3A%2F%2Floinc.org%2C1234-5&_tag=http%3A%2F%2Fexample.org%2Ftags%2Csample-tag&_security=RBAC%2CCONFIDENTIAL&_profile=http%3A%2F%2Fexample.org%2Ffhir%2FStructureDefinition%2Fcustom-profile' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Bodyapplication/json
resourceTypeanyrequired

This is a Bundle resource

Value"Bundle"
Example: "Bundle"
idstring(id)^[A-Za-z0-9\-\.]{1,64}$

Any combination of letters, numerals, "-" and ".", with a length limit of 64 characters. (This might be an integer, an unprefixed OID, UUID or any other identifier pattern that meets these constraints.) Ids are case-insensitive.

Example: "example-id"
metaobject(Meta)

The metadata about a resource. This is content in the resource that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

implicitRulesstring(uri)^\S*$

String of characters used to identify a name or a resource

Example: "https://example.org/resource"
_implicitRulesobject(Element)

Base definition for all elements in a resource.

languagestring(code)^[^\s]+(\s[^\s]+)*$

A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents

Example: "sample-code"
_languageobject(Element)

Base definition for all elements in a resource.

identifierobject(Identifier)

An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.

typeany

Indicates the purpose of this bundle - how it is intended to be used.

Enum"document""message""transaction""transaction-response""batch""batch-response""history""searchset""collection"
Example: "searchset"
_typeobject(Element)

Base definition for all elements in a resource.

timestampstring(date-time)(instant)^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-...

An instant in time - known at least to the second

Example: "2024-01-01T00:00:00Z"
_timestampobject(Element)

Base definition for all elements in a resource.

totalnumber(unsignedInt)^[0]|([1-9][0-9]*)$

An integer with a value that is not negative (e.g. >= 0)

Example: 0
_totalobject(Element)

Base definition for all elements in a resource.

linkArray of objects(Bundle_Link)

A series of links that provide context to this bundle.

Example: [{"relation":"search","url":"https://api.heydonto.com/fhir/family-member-history/?_count=20"},{"relation":"next","url":"https://api.heydonto.com/fhir/family-member-history/?_count=20&_page_token=TOKEN"},{"relation":"first","url":"https://api.heydonto.com/fhir/family-member-history/?_count=20"},{"relation":"self","url":"https://api.heydonto.com/fhir/family-member-history/?_count=20"}]
entryArray of objects(FamilyMemberHistory)

An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only).

Example: [{"resourceType":"FamilyMemberHistory","id":"father","text":{"status":"generated","div":"<div xmlns=\"http://www.w3.org/1999/xhtml\">Father died of a heart attack aged 74</div>"},"identifier":[{"value":"12345"}],"instantiatesUri":["http://example.org/family-member-history-questionnaire"],"status":"completed","patient":{"reference":"Patient/example","display":"Peter Patient"},"date":"2011-03-18","relationship":{"coding":[{"system":"http://terminology.hl7.org/CodeSystem/v3-RoleCode","code":"FTH","display":"father"}]},"sex":{"coding":[{"system":"http://hl7.org/fhir/administrative-gender","code":"male","display":"Male"}]},"condition":[{"code":{"coding":[{"system":"http://snomed.info/sct","code":"315619001","display":"Myocardial Infarction"}],"text":"Heart Attack"},"contributedToDeath":true,"onsetAge":{"value":74,"unit":"yr","system":"http://unitsofmeasure.org","code":"a"},"note":[{"text":"Was fishing at the time. At least he went doing someting he loved."}]}]}]
signatureobject(Signature)

A signature along with supporting context. The signature may be a digital signature that is cryptographic in nature, or some other signature acceptable to the domain. This other signature may be as simple as a graphical image representing a hand-written signature, or a signature ceremony Different signature approaches have different utilities.

Response
application/json
{
  "resourceType": "Bundle",
  "type": "searchset",
  "total": 100,
  "link": [
    { … },
    { … },
    { … },
    { … }
  ],
  "entry": [
    { … }
  ]
}

Create FHIR r4 family member history

Request

Security
bearer or bearer
Path
siteIdstringrequired

Site identifier

Bodyapplication/jsonrequired
resourceTypeanyrequired

This is a FamilyMemberHistory resource

Value"FamilyMemberHistory"
Example: "FamilyMemberHistory"
idstring(id)^[A-Za-z0-9\-\.]{1,64}$

Any combination of letters, numerals, "-" and ".", with a length limit of 64 characters. (This might be an integer, an unprefixed OID, UUID or any other identifier pattern that meets these constraints.) Ids are case-insensitive.

Example: "example-id"
metaobject(Meta)

The metadata about a resource. This is content in the resource that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

implicitRulesstring(uri)^\S*$

String of characters used to identify a name or a resource

Example: "https://example.org/resource"
_implicitRulesobject(Element)

Base definition for all elements in a resource.

languagestring(code)^[^\s]+(\s[^\s]+)*$

A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents

Example: "sample-code"
_languageobject(Element)

Base definition for all elements in a resource.

textobject(Narrative)

A human-readable summary of the resource conveying the essential clinical and business information for the resource.

containedArray of #Account (object) or #ActivityDefinition (object) or #AdverseEvent (object) or #AllergyIntolerance (object) or #Appointment (object) or #AppointmentResponse (object) or #AuditEvent (object) or #Basic (object) or #Binary (object) or #BiologicallyDerivedProduct (object) or #BodyStructure (object) or #Bundle (object) or #CapabilityStatement (object) or #CarePlan (object) or #CareTeam (object) or #CatalogEntry (object) or #ChargeItem (object) or #ChargeItemDefinition (object) or #Claim (object) or #ClaimResponse (object) or #ClinicalImpression (object) or #CodeSystem (object) or #Communication (object) or #CommunicationRequest (object) or #CompartmentDefinition (object) or #Composition (object) or #ConceptMap (object) or #Condition (object) or #Consent (object) or #Contract (object) or #Coverage (object) or #CoverageEligibilityRequest (object) or #CoverageEligibilityResponse (object) or #DetectedIssue (object) or #Device (object) or #DeviceDefinition (object) or #DeviceMetric (object) or #DeviceRequest (object) or #DeviceUseStatement (object) or #DiagnosticReport (object) or #DocumentManifest (object) or #DocumentReference (object) or #EffectEvidenceSynthesis (object) or #Encounter (object) or #Endpoint (object) or #EnrollmentRequest (object) or #EnrollmentResponse (object) or #EpisodeOfCare (object) or #EventDefinition (object) or #Evidence (object) or #EvidenceVariable (object) or #ExampleScenario (object) or #ExplanationOfBenefit (object) or #FamilyMemberHistory (object) or #Flag (object) or #Goal (object) or #GraphDefinition (object) or #Group (object) or #GuidanceResponse (object) or #HealthcareService (object) or #ImagingStudy (object) or #Immunization (object) or #ImmunizationEvaluation (object) or #ImmunizationRecommendation (object) or #ImplementationGuide (object) or #InsurancePlan (object) or #Invoice (object) or #Library (object) or #Linkage (object) or #List (object) or #Location (object) or #Measure (object) or #MeasureReport (object) or #Media (object) or #Medication (object) or #MedicationAdministration (object) or #MedicationDispense (object) or #MedicationKnowledge (object) or #MedicationRequest (object) or #MedicationStatement (object) or #MedicinalProduct (object) or #MedicinalProductAuthorization (object) or #MedicinalProductContraindication (object) or #MedicinalProductIndication (object) or #MedicinalProductIngredient (object) or #MedicinalProductInteraction (object) or #MedicinalProductManufactured (object) or #MedicinalProductPackaged (object) or #MedicinalProductPharmaceutical (object) or #MedicinalProductUndesirableEffect (object) or #MessageDefinition (object) or #MessageHeader (object) or #MolecularSequence (object) or #NamingSystem (object) or #NutritionOrder (object) or #Observation (object) or #ObservationDefinition (object) or #OperationDefinition (object) or #OperationOutcome (object) or #Organization (object) or #OrganizationAffiliation (object) or #Parameters (object) or #Patient (object) or #PaymentNotice (object) or #PaymentReconciliation (object) or #Person (object) or #PlanDefinition (object) or #Practitioner (object) or #PractitionerRole (object) or #Procedure (object) or #Provenance (object) or #Questionnaire (object) or #QuestionnaireResponse (object) or #RelatedPerson (object) or #RequestGroup (object) or #ResearchDefinition (object) or #ResearchElementDefinition (object) or #ResearchStudy (object) or #ResearchSubject (object) or #RiskAssessment (object) or #RiskEvidenceSynthesis (object) or #Schedule (object) or #SearchParameter (object) or #ServiceRequest (object) or #Slot (object) or #Specimen (object) or #SpecimenDefinition (object) or #StructureDefinition (object) or #StructureMap (object) or #Subscription (object) or #Substance (object) or #SubstanceNucleicAcid (object) or #SubstancePolymer (object) or #SubstanceProtein (object) or #SubstanceReferenceInformation (object) or #SubstanceSourceMaterial (object) or #SubstanceSpecification (object) or #SupplyDelivery (object) or #SupplyRequest (object) or #Task (object) or #TerminologyCapabilities (object) or #TestReport (object) or #TestScript (object) or #ValueSet (object) or #VerificationResult (object) or #VisionPrescription (object)(ResourceList)

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

extensionArray of objects(Extension)

May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

modifierExtensionArray of objects(Extension)

May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

identifierArray of objects(Identifier)

Business identifiers assigned to this family member history by the performer or other systems which remain constant as the resource is updated and propagates from server to server.

Example: [{"value":"12345"}]
instantiatesCanonicalArray of strings(canonical)

The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this FamilyMemberHistory.

Example: ["http://example.org/Profile"]
instantiatesUriArray of strings(uri)

The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this FamilyMemberHistory.

Example: ["http://example.org/family-member-history-questionnaire"]
_instantiatesUriArray of objects(Element)

Extensions for instantiatesUri

statusany

A code specifying the status of the record of the family history of a specific family member.

Enum"partial""completed""entered-in-error""health-unknown"
Example: "completed"
_statusobject(Element)

Base definition for all elements in a resource.

dataAbsentReasonobject(CodeableConcept)

A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

patientobject(Reference)required

A reference from one resource to another.

patient.​idstring

An extension object type #string.

Example: "example-string"
patient.​extensionArray of objects(#Extension)

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

patient.​referencestring

An extension object type #string.

Example: "example-string"
patient.​_referenceobject(#Element)

An extension object type #Element.

patient.​typestring

An extension object type #uri.

Example: "https://example.org/resource"
patient.​_typeobject(#Element)

An extension object type #Element.

patient.​identifierobject(#Identifier)

An extension object type #Identifier.

patient.​displaystring

An extension object type #string.

Example: "example-string"
patient.​_displayobject(#Element)

An extension object type #Element.

datestring(date-time)(dateTime)^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-...

A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.

Example: "2024-01-01T00:00:00Z"
_dateobject(Element)

Base definition for all elements in a resource.

namestring(string)^[ \r\n\t\S]+$

A sequence of Unicode characters

Example: "example-string"
_nameobject(Element)

Base definition for all elements in a resource.

relationshipobject(CodeableConcept)required

A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

relationship.​idstring

An extension object type #string.

Example: "example-string"
relationship.​extensionArray of objects(#Extension)

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

relationship.​codingArray of objects(#Coding)

A reference to a code defined by a terminology system.

relationship.​textstring

An extension object type #string.

Example: "example-string"
relationship.​_textobject(#Element)

An extension object type #Element.

sexobject(CodeableConcept)

A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

bornPeriodobject(Period)

A time period defined by a start and end date and optionally time.

bornDatestring^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-...

The actual or approximate date of birth of the relative.

Example: "example-string"
_bornDateobject(Element)

Base definition for all elements in a resource.

bornStringstring^[ \r\n\t\S]+$

The actual or approximate date of birth of the relative.

Example: "example-string"
_bornStringobject(Element)

Base definition for all elements in a resource.

ageAgeobject(Age)

A duration of time during which an organism (or a process) has existed.

ageRangeobject(Range)

A set of ordered Quantities defined by a low and high limit.

ageStringstring^[ \r\n\t\S]+$

The age of the relative at the time the family member history is recorded.

Example: "example-string"
_ageStringobject(Element)

Base definition for all elements in a resource.

estimatedAgeboolean(boolean)^true|false$

Value of "true" or "false"

Example: true
_estimatedAgeobject(Element)

Base definition for all elements in a resource.

deceasedBooleanboolean^true|false$

Deceased flag or the actual or approximate age of the relative at the time of death for the family member history record.

Example: true
_deceasedBooleanobject(Element)

Base definition for all elements in a resource.

deceasedAgeobject(Age)

A duration of time during which an organism (or a process) has existed.

deceasedRangeobject(Range)

A set of ordered Quantities defined by a low and high limit.

deceasedDatestring^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-...

Deceased flag or the actual or approximate age of the relative at the time of death for the family member history record.

Example: "example-string"
_deceasedDateobject(Element)

Base definition for all elements in a resource.

deceasedStringstring^[ \r\n\t\S]+$

Deceased flag or the actual or approximate age of the relative at the time of death for the family member history record.

Example: "example-string"
_deceasedStringobject(Element)

Base definition for all elements in a resource.

reasonCodeArray of objects(CodeableConcept)

Describes why the family member history occurred in coded or textual form.

reasonReferenceArray of objects(Reference)

Indicates a Condition, Observation, AllergyIntolerance, or QuestionnaireResponse that justifies this family member history event.

noteArray of objects(Annotation)

This property allows a non condition-specific note to the made about the related person. Ideally, the note would be in the condition property, but this is not always possible.

conditionArray of objects(FamilyMemberHistory_Condition)

The significant Conditions (or condition) that the family member had. This is a repeating section to allow a system to represent more than one condition per resource, though there is nothing stopping multiple resources - one per condition.

Example: [{"code":{"coding":[{"system":"http://snomed.info/sct","code":"315619001","display":"Myocardial Infarction"}],"text":"Heart Attack"},"contributedToDeath":true,"onsetAge":{"value":74,"unit":"yr","system":"http://unitsofmeasure.org","code":"a"},"note":[{"text":"Was fishing at the time. At least he went doing someting he loved."}]}]
curl -i -X POST \
  'https://docs.heydonto.com/_mock/apis/fhir/openapi/site/{siteId}/fhir/family-member-history' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "resourceType": "FamilyMemberHistory",
    "id": "father",
    "text": {
      "status": "generated",
      "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">Father died of a heart attack aged 74</div>"
    },
    "identifier": [
      {
        "value": "12345"
      }
    ],
    "instantiatesUri": [
      "http://example.org/family-member-history-questionnaire"
    ],
    "status": "completed",
    "patient": {
      "reference": "Patient/example",
      "display": "Peter Patient"
    },
    "date": "2011-03-18",
    "relationship": {
      "coding": [
        {
          "system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
          "code": "FTH",
          "display": "father"
        }
      ]
    },
    "sex": {
      "coding": [
        {
          "system": "http://hl7.org/fhir/administrative-gender",
          "code": "male",
          "display": "Male"
        }
      ]
    },
    "condition": [
      {
        "code": {
          "coding": [
            {
              "system": "http://snomed.info/sct",
              "code": "315619001",
              "display": "Myocardial Infarction"
            }
          ],
          "text": "Heart Attack"
        },
        "contributedToDeath": true,
        "onsetAge": {
          "value": 74,
          "unit": "yr",
          "system": "http://unitsofmeasure.org",
          "code": "a"
        },
        "note": [
          {
            "text": "Was fishing at the time. At least he went doing someting he loved."
          }
        ]
      }
    ]
  }'

Responses

Bodyapplication/json
resourceTypeanyrequired

This is a FamilyMemberHistory resource

Value"FamilyMemberHistory"
Example: "FamilyMemberHistory"
idstring(id)^[A-Za-z0-9\-\.]{1,64}$

Any combination of letters, numerals, "-" and ".", with a length limit of 64 characters. (This might be an integer, an unprefixed OID, UUID or any other identifier pattern that meets these constraints.) Ids are case-insensitive.

Example: "example-id"
metaobject(Meta)

The metadata about a resource. This is content in the resource that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

implicitRulesstring(uri)^\S*$

String of characters used to identify a name or a resource

Example: "https://example.org/resource"
_implicitRulesobject(Element)

Base definition for all elements in a resource.

languagestring(code)^[^\s]+(\s[^\s]+)*$

A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents

Example: "sample-code"
_languageobject(Element)

Base definition for all elements in a resource.

textobject(Narrative)

A human-readable summary of the resource conveying the essential clinical and business information for the resource.

containedArray of #Account (object) or #ActivityDefinition (object) or #AdverseEvent (object) or #AllergyIntolerance (object) or #Appointment (object) or #AppointmentResponse (object) or #AuditEvent (object) or #Basic (object) or #Binary (object) or #BiologicallyDerivedProduct (object) or #BodyStructure (object) or #Bundle (object) or #CapabilityStatement (object) or #CarePlan (object) or #CareTeam (object) or #CatalogEntry (object) or #ChargeItem (object) or #ChargeItemDefinition (object) or #Claim (object) or #ClaimResponse (object) or #ClinicalImpression (object) or #CodeSystem (object) or #Communication (object) or #CommunicationRequest (object) or #CompartmentDefinition (object) or #Composition (object) or #ConceptMap (object) or #Condition (object) or #Consent (object) or #Contract (object) or #Coverage (object) or #CoverageEligibilityRequest (object) or #CoverageEligibilityResponse (object) or #DetectedIssue (object) or #Device (object) or #DeviceDefinition (object) or #DeviceMetric (object) or #DeviceRequest (object) or #DeviceUseStatement (object) or #DiagnosticReport (object) or #DocumentManifest (object) or #DocumentReference (object) or #EffectEvidenceSynthesis (object) or #Encounter (object) or #Endpoint (object) or #EnrollmentRequest (object) or #EnrollmentResponse (object) or #EpisodeOfCare (object) or #EventDefinition (object) or #Evidence (object) or #EvidenceVariable (object) or #ExampleScenario (object) or #ExplanationOfBenefit (object) or #FamilyMemberHistory (object) or #Flag (object) or #Goal (object) or #GraphDefinition (object) or #Group (object) or #GuidanceResponse (object) or #HealthcareService (object) or #ImagingStudy (object) or #Immunization (object) or #ImmunizationEvaluation (object) or #ImmunizationRecommendation (object) or #ImplementationGuide (object) or #InsurancePlan (object) or #Invoice (object) or #Library (object) or #Linkage (object) or #List (object) or #Location (object) or #Measure (object) or #MeasureReport (object) or #Media (object) or #Medication (object) or #MedicationAdministration (object) or #MedicationDispense (object) or #MedicationKnowledge (object) or #MedicationRequest (object) or #MedicationStatement (object) or #MedicinalProduct (object) or #MedicinalProductAuthorization (object) or #MedicinalProductContraindication (object) or #MedicinalProductIndication (object) or #MedicinalProductIngredient (object) or #MedicinalProductInteraction (object) or #MedicinalProductManufactured (object) or #MedicinalProductPackaged (object) or #MedicinalProductPharmaceutical (object) or #MedicinalProductUndesirableEffect (object) or #MessageDefinition (object) or #MessageHeader (object) or #MolecularSequence (object) or #NamingSystem (object) or #NutritionOrder (object) or #Observation (object) or #ObservationDefinition (object) or #OperationDefinition (object) or #OperationOutcome (object) or #Organization (object) or #OrganizationAffiliation (object) or #Parameters (object) or #Patient (object) or #PaymentNotice (object) or #PaymentReconciliation (object) or #Person (object) or #PlanDefinition (object) or #Practitioner (object) or #PractitionerRole (object) or #Procedure (object) or #Provenance (object) or #Questionnaire (object) or #QuestionnaireResponse (object) or #RelatedPerson (object) or #RequestGroup (object) or #ResearchDefinition (object) or #ResearchElementDefinition (object) or #ResearchStudy (object) or #ResearchSubject (object) or #RiskAssessment (object) or #RiskEvidenceSynthesis (object) or #Schedule (object) or #SearchParameter (object) or #ServiceRequest (object) or #Slot (object) or #Specimen (object) or #SpecimenDefinition (object) or #StructureDefinition (object) or #StructureMap (object) or #Subscription (object) or #Substance (object) or #SubstanceNucleicAcid (object) or #SubstancePolymer (object) or #SubstanceProtein (object) or #SubstanceReferenceInformation (object) or #SubstanceSourceMaterial (object) or #SubstanceSpecification (object) or #SupplyDelivery (object) or #SupplyRequest (object) or #Task (object) or #TerminologyCapabilities (object) or #TestReport (object) or #TestScript (object) or #ValueSet (object) or #VerificationResult (object) or #VisionPrescription (object)(ResourceList)

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

extensionArray of objects(Extension)

May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

modifierExtensionArray of objects(Extension)

May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

identifierArray of objects(Identifier)

Business identifiers assigned to this family member history by the performer or other systems which remain constant as the resource is updated and propagates from server to server.

Example: [{"value":"12345"}]
instantiatesCanonicalArray of strings(canonical)

The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this FamilyMemberHistory.

Example: ["http://example.org/Profile"]
instantiatesUriArray of strings(uri)

The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this FamilyMemberHistory.

Example: ["http://example.org/family-member-history-questionnaire"]
_instantiatesUriArray of objects(Element)

Extensions for instantiatesUri

statusany

A code specifying the status of the record of the family history of a specific family member.

Enum"partial""completed""entered-in-error""health-unknown"
Example: "completed"
_statusobject(Element)

Base definition for all elements in a resource.

dataAbsentReasonobject(CodeableConcept)

A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

patientobject(Reference)required

A reference from one resource to another.

patient.​idstring

An extension object type #string.

Example: "example-string"
patient.​extensionArray of objects(#Extension)

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

patient.​referencestring

An extension object type #string.

Example: "example-string"
patient.​_referenceobject(#Element)

An extension object type #Element.

patient.​typestring

An extension object type #uri.

Example: "https://example.org/resource"
patient.​_typeobject(#Element)

An extension object type #Element.

patient.​identifierobject(#Identifier)

An extension object type #Identifier.

patient.​displaystring

An extension object type #string.

Example: "example-string"
patient.​_displayobject(#Element)

An extension object type #Element.

datestring(date-time)(dateTime)^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-...

A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.

Example: "2024-01-01T00:00:00Z"
_dateobject(Element)

Base definition for all elements in a resource.

namestring(string)^[ \r\n\t\S]+$

A sequence of Unicode characters

Example: "example-string"
_nameobject(Element)

Base definition for all elements in a resource.

relationshipobject(CodeableConcept)required

A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

relationship.​idstring

An extension object type #string.

Example: "example-string"
relationship.​extensionArray of objects(#Extension)

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

relationship.​codingArray of objects(#Coding)

A reference to a code defined by a terminology system.

relationship.​textstring

An extension object type #string.

Example: "example-string"
relationship.​_textobject(#Element)

An extension object type #Element.

sexobject(CodeableConcept)

A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

bornPeriodobject(Period)

A time period defined by a start and end date and optionally time.

bornDatestring^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-...

The actual or approximate date of birth of the relative.

Example: "example-string"
_bornDateobject(Element)

Base definition for all elements in a resource.

bornStringstring^[ \r\n\t\S]+$

The actual or approximate date of birth of the relative.

Example: "example-string"
_bornStringobject(Element)

Base definition for all elements in a resource.

ageAgeobject(Age)

A duration of time during which an organism (or a process) has existed.

ageRangeobject(Range)

A set of ordered Quantities defined by a low and high limit.

ageStringstring^[ \r\n\t\S]+$

The age of the relative at the time the family member history is recorded.

Example: "example-string"
_ageStringobject(Element)

Base definition for all elements in a resource.

estimatedAgeboolean(boolean)^true|false$

Value of "true" or "false"

Example: true
_estimatedAgeobject(Element)

Base definition for all elements in a resource.

deceasedBooleanboolean^true|false$

Deceased flag or the actual or approximate age of the relative at the time of death for the family member history record.

Example: true
_deceasedBooleanobject(Element)

Base definition for all elements in a resource.

deceasedAgeobject(Age)

A duration of time during which an organism (or a process) has existed.

deceasedRangeobject(Range)

A set of ordered Quantities defined by a low and high limit.

deceasedDatestring^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-...

Deceased flag or the actual or approximate age of the relative at the time of death for the family member history record.

Example: "example-string"
_deceasedDateobject(Element)

Base definition for all elements in a resource.

deceasedStringstring^[ \r\n\t\S]+$

Deceased flag or the actual or approximate age of the relative at the time of death for the family member history record.

Example: "example-string"
_deceasedStringobject(Element)

Base definition for all elements in a resource.

reasonCodeArray of objects(CodeableConcept)

Describes why the family member history occurred in coded or textual form.

reasonReferenceArray of objects(Reference)

Indicates a Condition, Observation, AllergyIntolerance, or QuestionnaireResponse that justifies this family member history event.

noteArray of objects(Annotation)

This property allows a non condition-specific note to the made about the related person. Ideally, the note would be in the condition property, but this is not always possible.

conditionArray of objects(FamilyMemberHistory_Condition)

The significant Conditions (or condition) that the family member had. This is a repeating section to allow a system to represent more than one condition per resource, though there is nothing stopping multiple resources - one per condition.

Example: [{"code":{"coding":[{"system":"http://snomed.info/sct","code":"315619001","display":"Myocardial Infarction"}],"text":"Heart Attack"},"contributedToDeath":true,"onsetAge":{"value":74,"unit":"yr","system":"http://unitsofmeasure.org","code":"a"},"note":[{"text":"Was fishing at the time. At least he went doing someting he loved."}]}]
Response
application/json
{
  "resourceType": "FamilyMemberHistory",
  "id": "father",
  "text": {
    "status": "generated",
    "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">Father died of a heart attack aged 74</div>"
  },
  "identifier": [
    { … }
  ],
  "instantiatesUri": [
    "http://example.org/family-member-history-questionnaire"
  ],
  "status": "completed",
  "patient": {
    "reference": "Patient/example",
    "display": "Peter Patient"
  },
  "date": "2011-03-18",
  "relationship": {
    "coding": [ … ]
  },
  "sex": {
    "coding": [ … ]
  },
  "condition": [
    { … }
  ]
}

Get FHIR r4 family member history by ID

Request

Security
bearer or bearer
Path
idstringrequired

ID of the FamilyMemberHistory

siteIdstringrequired

Site identifier

curl -i -X GET \
  'https://docs.heydonto.com/_mock/apis/fhir/openapi/site/{siteId}/fhir/family-member-history/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Bodyapplication/json
resourceTypeanyrequired

This is a FamilyMemberHistory resource

Value"FamilyMemberHistory"
Example: "FamilyMemberHistory"
idstring(id)^[A-Za-z0-9\-\.]{1,64}$

Any combination of letters, numerals, "-" and ".", with a length limit of 64 characters. (This might be an integer, an unprefixed OID, UUID or any other identifier pattern that meets these constraints.) Ids are case-insensitive.

Example: "example-id"
metaobject(Meta)

The metadata about a resource. This is content in the resource that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

implicitRulesstring(uri)^\S*$

String of characters used to identify a name or a resource

Example: "https://example.org/resource"
_implicitRulesobject(Element)

Base definition for all elements in a resource.

languagestring(code)^[^\s]+(\s[^\s]+)*$

A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents

Example: "sample-code"
_languageobject(Element)

Base definition for all elements in a resource.

textobject(Narrative)

A human-readable summary of the resource conveying the essential clinical and business information for the resource.

containedArray of #Account (object) or #ActivityDefinition (object) or #AdverseEvent (object) or #AllergyIntolerance (object) or #Appointment (object) or #AppointmentResponse (object) or #AuditEvent (object) or #Basic (object) or #Binary (object) or #BiologicallyDerivedProduct (object) or #BodyStructure (object) or #Bundle (object) or #CapabilityStatement (object) or #CarePlan (object) or #CareTeam (object) or #CatalogEntry (object) or #ChargeItem (object) or #ChargeItemDefinition (object) or #Claim (object) or #ClaimResponse (object) or #ClinicalImpression (object) or #CodeSystem (object) or #Communication (object) or #CommunicationRequest (object) or #CompartmentDefinition (object) or #Composition (object) or #ConceptMap (object) or #Condition (object) or #Consent (object) or #Contract (object) or #Coverage (object) or #CoverageEligibilityRequest (object) or #CoverageEligibilityResponse (object) or #DetectedIssue (object) or #Device (object) or #DeviceDefinition (object) or #DeviceMetric (object) or #DeviceRequest (object) or #DeviceUseStatement (object) or #DiagnosticReport (object) or #DocumentManifest (object) or #DocumentReference (object) or #EffectEvidenceSynthesis (object) or #Encounter (object) or #Endpoint (object) or #EnrollmentRequest (object) or #EnrollmentResponse (object) or #EpisodeOfCare (object) or #EventDefinition (object) or #Evidence (object) or #EvidenceVariable (object) or #ExampleScenario (object) or #ExplanationOfBenefit (object) or #FamilyMemberHistory (object) or #Flag (object) or #Goal (object) or #GraphDefinition (object) or #Group (object) or #GuidanceResponse (object) or #HealthcareService (object) or #ImagingStudy (object) or #Immunization (object) or #ImmunizationEvaluation (object) or #ImmunizationRecommendation (object) or #ImplementationGuide (object) or #InsurancePlan (object) or #Invoice (object) or #Library (object) or #Linkage (object) or #List (object) or #Location (object) or #Measure (object) or #MeasureReport (object) or #Media (object) or #Medication (object) or #MedicationAdministration (object) or #MedicationDispense (object) or #MedicationKnowledge (object) or #MedicationRequest (object) or #MedicationStatement (object) or #MedicinalProduct (object) or #MedicinalProductAuthorization (object) or #MedicinalProductContraindication (object) or #MedicinalProductIndication (object) or #MedicinalProductIngredient (object) or #MedicinalProductInteraction (object) or #MedicinalProductManufactured (object) or #MedicinalProductPackaged (object) or #MedicinalProductPharmaceutical (object) or #MedicinalProductUndesirableEffect (object) or #MessageDefinition (object) or #MessageHeader (object) or #MolecularSequence (object) or #NamingSystem (object) or #NutritionOrder (object) or #Observation (object) or #ObservationDefinition (object) or #OperationDefinition (object) or #OperationOutcome (object) or #Organization (object) or #OrganizationAffiliation (object) or #Parameters (object) or #Patient (object) or #PaymentNotice (object) or #PaymentReconciliation (object) or #Person (object) or #PlanDefinition (object) or #Practitioner (object) or #PractitionerRole (object) or #Procedure (object) or #Provenance (object) or #Questionnaire (object) or #QuestionnaireResponse (object) or #RelatedPerson (object) or #RequestGroup (object) or #ResearchDefinition (object) or #ResearchElementDefinition (object) or #ResearchStudy (object) or #ResearchSubject (object) or #RiskAssessment (object) or #RiskEvidenceSynthesis (object) or #Schedule (object) or #SearchParameter (object) or #ServiceRequest (object) or #Slot (object) or #Specimen (object) or #SpecimenDefinition (object) or #StructureDefinition (object) or #StructureMap (object) or #Subscription (object) or #Substance (object) or #SubstanceNucleicAcid (object) or #SubstancePolymer (object) or #SubstanceProtein (object) or #SubstanceReferenceInformation (object) or #SubstanceSourceMaterial (object) or #SubstanceSpecification (object) or #SupplyDelivery (object) or #SupplyRequest (object) or #Task (object) or #TerminologyCapabilities (object) or #TestReport (object) or #TestScript (object) or #ValueSet (object) or #VerificationResult (object) or #VisionPrescription (object)(ResourceList)

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

extensionArray of objects(Extension)

May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

modifierExtensionArray of objects(Extension)

May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

identifierArray of objects(Identifier)

Business identifiers assigned to this family member history by the performer or other systems which remain constant as the resource is updated and propagates from server to server.

Example: [{"value":"12345"}]
instantiatesCanonicalArray of strings(canonical)

The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this FamilyMemberHistory.

Example: ["http://example.org/Profile"]
instantiatesUriArray of strings(uri)

The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this FamilyMemberHistory.

Example: ["http://example.org/family-member-history-questionnaire"]
_instantiatesUriArray of objects(Element)

Extensions for instantiatesUri

statusany

A code specifying the status of the record of the family history of a specific family member.

Enum"partial""completed""entered-in-error""health-unknown"
Example: "completed"
_statusobject(Element)

Base definition for all elements in a resource.

dataAbsentReasonobject(CodeableConcept)

A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

patientobject(Reference)required

A reference from one resource to another.

patient.​idstring

An extension object type #string.

Example: "example-string"
patient.​extensionArray of objects(#Extension)

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

patient.​referencestring

An extension object type #string.

Example: "example-string"
patient.​_referenceobject(#Element)

An extension object type #Element.

patient.​typestring

An extension object type #uri.

Example: "https://example.org/resource"
patient.​_typeobject(#Element)

An extension object type #Element.

patient.​identifierobject(#Identifier)

An extension object type #Identifier.

patient.​displaystring

An extension object type #string.

Example: "example-string"
patient.​_displayobject(#Element)

An extension object type #Element.

datestring(date-time)(dateTime)^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-...

A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.

Example: "2024-01-01T00:00:00Z"
_dateobject(Element)

Base definition for all elements in a resource.

namestring(string)^[ \r\n\t\S]+$

A sequence of Unicode characters

Example: "example-string"
_nameobject(Element)

Base definition for all elements in a resource.

relationshipobject(CodeableConcept)required

A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

relationship.​idstring

An extension object type #string.

Example: "example-string"
relationship.​extensionArray of objects(#Extension)

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

relationship.​codingArray of objects(#Coding)

A reference to a code defined by a terminology system.

relationship.​textstring

An extension object type #string.

Example: "example-string"
relationship.​_textobject(#Element)

An extension object type #Element.

sexobject(CodeableConcept)

A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

bornPeriodobject(Period)

A time period defined by a start and end date and optionally time.

bornDatestring^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-...

The actual or approximate date of birth of the relative.

Example: "example-string"
_bornDateobject(Element)

Base definition for all elements in a resource.

bornStringstring^[ \r\n\t\S]+$

The actual or approximate date of birth of the relative.

Example: "example-string"
_bornStringobject(Element)

Base definition for all elements in a resource.

ageAgeobject(Age)

A duration of time during which an organism (or a process) has existed.

ageRangeobject(Range)

A set of ordered Quantities defined by a low and high limit.

ageStringstring^[ \r\n\t\S]+$

The age of the relative at the time the family member history is recorded.

Example: "example-string"
_ageStringobject(Element)

Base definition for all elements in a resource.

estimatedAgeboolean(boolean)^true|false$

Value of "true" or "false"

Example: true
_estimatedAgeobject(Element)

Base definition for all elements in a resource.

deceasedBooleanboolean^true|false$

Deceased flag or the actual or approximate age of the relative at the time of death for the family member history record.

Example: true
_deceasedBooleanobject(Element)

Base definition for all elements in a resource.

deceasedAgeobject(Age)

A duration of time during which an organism (or a process) has existed.

deceasedRangeobject(Range)

A set of ordered Quantities defined by a low and high limit.

deceasedDatestring^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-...

Deceased flag or the actual or approximate age of the relative at the time of death for the family member history record.

Example: "example-string"
_deceasedDateobject(Element)

Base definition for all elements in a resource.

deceasedStringstring^[ \r\n\t\S]+$

Deceased flag or the actual or approximate age of the relative at the time of death for the family member history record.

Example: "example-string"
_deceasedStringobject(Element)

Base definition for all elements in a resource.

reasonCodeArray of objects(CodeableConcept)

Describes why the family member history occurred in coded or textual form.

reasonReferenceArray of objects(Reference)

Indicates a Condition, Observation, AllergyIntolerance, or QuestionnaireResponse that justifies this family member history event.

noteArray of objects(Annotation)

This property allows a non condition-specific note to the made about the related person. Ideally, the note would be in the condition property, but this is not always possible.

conditionArray of objects(FamilyMemberHistory_Condition)

The significant Conditions (or condition) that the family member had. This is a repeating section to allow a system to represent more than one condition per resource, though there is nothing stopping multiple resources - one per condition.

Example: [{"code":{"coding":[{"system":"http://snomed.info/sct","code":"315619001","display":"Myocardial Infarction"}],"text":"Heart Attack"},"contributedToDeath":true,"onsetAge":{"value":74,"unit":"yr","system":"http://unitsofmeasure.org","code":"a"},"note":[{"text":"Was fishing at the time. At least he went doing someting he loved."}]}]
Response
application/json
{
  "resourceType": "FamilyMemberHistory",
  "id": "father",
  "text": {
    "status": "generated",
    "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">Father died of a heart attack aged 74</div>"
  },
  "identifier": [
    { … }
  ],
  "instantiatesUri": [
    "http://example.org/family-member-history-questionnaire"
  ],
  "status": "completed",
  "patient": {
    "reference": "Patient/example",
    "display": "Peter Patient"
  },
  "date": "2011-03-18",
  "relationship": {
    "coding": [ … ]
  },
  "sex": {
    "coding": [ … ]
  },
  "condition": [
    { … }
  ]
}

Update FHIR r4 family member history

Request

Security
bearer or bearer
Path
siteIdstringrequired

Site identifier

idstringrequired

ID of the FamilyMemberHistory to update

Bodyapplication/jsonrequired
resourceTypeanyrequired

This is a FamilyMemberHistory resource

Value"FamilyMemberHistory"
Example: "FamilyMemberHistory"
idstring(id)^[A-Za-z0-9\-\.]{1,64}$

Any combination of letters, numerals, "-" and ".", with a length limit of 64 characters. (This might be an integer, an unprefixed OID, UUID or any other identifier pattern that meets these constraints.) Ids are case-insensitive.

Example: "example-id"
metaobject(Meta)

The metadata about a resource. This is content in the resource that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

implicitRulesstring(uri)^\S*$

String of characters used to identify a name or a resource

Example: "https://example.org/resource"
_implicitRulesobject(Element)

Base definition for all elements in a resource.

languagestring(code)^[^\s]+(\s[^\s]+)*$

A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents

Example: "sample-code"
_languageobject(Element)

Base definition for all elements in a resource.

textobject(Narrative)

A human-readable summary of the resource conveying the essential clinical and business information for the resource.

containedArray of #Account (object) or #ActivityDefinition (object) or #AdverseEvent (object) or #AllergyIntolerance (object) or #Appointment (object) or #AppointmentResponse (object) or #AuditEvent (object) or #Basic (object) or #Binary (object) or #BiologicallyDerivedProduct (object) or #BodyStructure (object) or #Bundle (object) or #CapabilityStatement (object) or #CarePlan (object) or #CareTeam (object) or #CatalogEntry (object) or #ChargeItem (object) or #ChargeItemDefinition (object) or #Claim (object) or #ClaimResponse (object) or #ClinicalImpression (object) or #CodeSystem (object) or #Communication (object) or #CommunicationRequest (object) or #CompartmentDefinition (object) or #Composition (object) or #ConceptMap (object) or #Condition (object) or #Consent (object) or #Contract (object) or #Coverage (object) or #CoverageEligibilityRequest (object) or #CoverageEligibilityResponse (object) or #DetectedIssue (object) or #Device (object) or #DeviceDefinition (object) or #DeviceMetric (object) or #DeviceRequest (object) or #DeviceUseStatement (object) or #DiagnosticReport (object) or #DocumentManifest (object) or #DocumentReference (object) or #EffectEvidenceSynthesis (object) or #Encounter (object) or #Endpoint (object) or #EnrollmentRequest (object) or #EnrollmentResponse (object) or #EpisodeOfCare (object) or #EventDefinition (object) or #Evidence (object) or #EvidenceVariable (object) or #ExampleScenario (object) or #ExplanationOfBenefit (object) or #FamilyMemberHistory (object) or #Flag (object) or #Goal (object) or #GraphDefinition (object) or #Group (object) or #GuidanceResponse (object) or #HealthcareService (object) or #ImagingStudy (object) or #Immunization (object) or #ImmunizationEvaluation (object) or #ImmunizationRecommendation (object) or #ImplementationGuide (object) or #InsurancePlan (object) or #Invoice (object) or #Library (object) or #Linkage (object) or #List (object) or #Location (object) or #Measure (object) or #MeasureReport (object) or #Media (object) or #Medication (object) or #MedicationAdministration (object) or #MedicationDispense (object) or #MedicationKnowledge (object) or #MedicationRequest (object) or #MedicationStatement (object) or #MedicinalProduct (object) or #MedicinalProductAuthorization (object) or #MedicinalProductContraindication (object) or #MedicinalProductIndication (object) or #MedicinalProductIngredient (object) or #MedicinalProductInteraction (object) or #MedicinalProductManufactured (object) or #MedicinalProductPackaged (object) or #MedicinalProductPharmaceutical (object) or #MedicinalProductUndesirableEffect (object) or #MessageDefinition (object) or #MessageHeader (object) or #MolecularSequence (object) or #NamingSystem (object) or #NutritionOrder (object) or #Observation (object) or #ObservationDefinition (object) or #OperationDefinition (object) or #OperationOutcome (object) or #Organization (object) or #OrganizationAffiliation (object) or #Parameters (object) or #Patient (object) or #PaymentNotice (object) or #PaymentReconciliation (object) or #Person (object) or #PlanDefinition (object) or #Practitioner (object) or #PractitionerRole (object) or #Procedure (object) or #Provenance (object) or #Questionnaire (object) or #QuestionnaireResponse (object) or #RelatedPerson (object) or #RequestGroup (object) or #ResearchDefinition (object) or #ResearchElementDefinition (object) or #ResearchStudy (object) or #ResearchSubject (object) or #RiskAssessment (object) or #RiskEvidenceSynthesis (object) or #Schedule (object) or #SearchParameter (object) or #ServiceRequest (object) or #Slot (object) or #Specimen (object) or #SpecimenDefinition (object) or #StructureDefinition (object) or #StructureMap (object) or #Subscription (object) or #Substance (object) or #SubstanceNucleicAcid (object) or #SubstancePolymer (object) or #SubstanceProtein (object) or #SubstanceReferenceInformation (object) or #SubstanceSourceMaterial (object) or #SubstanceSpecification (object) or #SupplyDelivery (object) or #SupplyRequest (object) or #Task (object) or #TerminologyCapabilities (object) or #TestReport (object) or #TestScript (object) or #ValueSet (object) or #VerificationResult (object) or #VisionPrescription (object)(ResourceList)

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

extensionArray of objects(Extension)

May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

modifierExtensionArray of objects(Extension)

May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

identifierArray of objects(Identifier)

Business identifiers assigned to this family member history by the performer or other systems which remain constant as the resource is updated and propagates from server to server.

Example: [{"value":"12345"}]
instantiatesCanonicalArray of strings(canonical)

The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this FamilyMemberHistory.

Example: ["http://example.org/Profile"]
instantiatesUriArray of strings(uri)

The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this FamilyMemberHistory.

Example: ["http://example.org/family-member-history-questionnaire"]
_instantiatesUriArray of objects(Element)

Extensions for instantiatesUri

statusany

A code specifying the status of the record of the family history of a specific family member.

Enum"partial""completed""entered-in-error""health-unknown"
Example: "completed"
_statusobject(Element)

Base definition for all elements in a resource.

dataAbsentReasonobject(CodeableConcept)

A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

patientobject(Reference)required

A reference from one resource to another.

patient.​idstring

An extension object type #string.

Example: "example-string"
patient.​extensionArray of objects(#Extension)

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

patient.​referencestring

An extension object type #string.

Example: "example-string"
patient.​_referenceobject(#Element)

An extension object type #Element.

patient.​typestring

An extension object type #uri.

Example: "https://example.org/resource"
patient.​_typeobject(#Element)

An extension object type #Element.

patient.​identifierobject(#Identifier)

An extension object type #Identifier.

patient.​displaystring

An extension object type #string.

Example: "example-string"
patient.​_displayobject(#Element)

An extension object type #Element.

datestring(date-time)(dateTime)^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-...

A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.

Example: "2024-01-01T00:00:00Z"
_dateobject(Element)

Base definition for all elements in a resource.

namestring(string)^[ \r\n\t\S]+$

A sequence of Unicode characters

Example: "example-string"
_nameobject(Element)

Base definition for all elements in a resource.

relationshipobject(CodeableConcept)required

A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

relationship.​idstring

An extension object type #string.

Example: "example-string"
relationship.​extensionArray of objects(#Extension)

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

relationship.​codingArray of objects(#Coding)

A reference to a code defined by a terminology system.

relationship.​textstring

An extension object type #string.

Example: "example-string"
relationship.​_textobject(#Element)

An extension object type #Element.

sexobject(CodeableConcept)

A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

bornPeriodobject(Period)

A time period defined by a start and end date and optionally time.

bornDatestring^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-...

The actual or approximate date of birth of the relative.

Example: "example-string"
_bornDateobject(Element)

Base definition for all elements in a resource.

bornStringstring^[ \r\n\t\S]+$

The actual or approximate date of birth of the relative.

Example: "example-string"
_bornStringobject(Element)

Base definition for all elements in a resource.

ageAgeobject(Age)

A duration of time during which an organism (or a process) has existed.

ageRangeobject(Range)

A set of ordered Quantities defined by a low and high limit.

ageStringstring^[ \r\n\t\S]+$

The age of the relative at the time the family member history is recorded.

Example: "example-string"
_ageStringobject(Element)

Base definition for all elements in a resource.

estimatedAgeboolean(boolean)^true|false$

Value of "true" or "false"

Example: true
_estimatedAgeobject(Element)

Base definition for all elements in a resource.

deceasedBooleanboolean^true|false$

Deceased flag or the actual or approximate age of the relative at the time of death for the family member history record.

Example: true
_deceasedBooleanobject(Element)

Base definition for all elements in a resource.

deceasedAgeobject(Age)

A duration of time during which an organism (or a process) has existed.

deceasedRangeobject(Range)

A set of ordered Quantities defined by a low and high limit.

deceasedDatestring^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-...

Deceased flag or the actual or approximate age of the relative at the time of death for the family member history record.

Example: "example-string"
_deceasedDateobject(Element)

Base definition for all elements in a resource.

deceasedStringstring^[ \r\n\t\S]+$

Deceased flag or the actual or approximate age of the relative at the time of death for the family member history record.

Example: "example-string"
_deceasedStringobject(Element)

Base definition for all elements in a resource.

reasonCodeArray of objects(CodeableConcept)

Describes why the family member history occurred in coded or textual form.

reasonReferenceArray of objects(Reference)

Indicates a Condition, Observation, AllergyIntolerance, or QuestionnaireResponse that justifies this family member history event.

noteArray of objects(Annotation)

This property allows a non condition-specific note to the made about the related person. Ideally, the note would be in the condition property, but this is not always possible.

conditionArray of objects(FamilyMemberHistory_Condition)

The significant Conditions (or condition) that the family member had. This is a repeating section to allow a system to represent more than one condition per resource, though there is nothing stopping multiple resources - one per condition.

Example: [{"code":{"coding":[{"system":"http://snomed.info/sct","code":"315619001","display":"Myocardial Infarction"}],"text":"Heart Attack"},"contributedToDeath":true,"onsetAge":{"value":74,"unit":"yr","system":"http://unitsofmeasure.org","code":"a"},"note":[{"text":"Was fishing at the time. At least he went doing someting he loved."}]}]
curl -i -X PUT \
  'https://docs.heydonto.com/_mock/apis/fhir/openapi/site/{siteId}/fhir/family-member-history/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "resourceType": "FamilyMemberHistory",
    "id": "father",
    "text": {
      "status": "generated",
      "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">Father died of a heart attack aged 74</div>"
    },
    "identifier": [
      {
        "value": "12345"
      }
    ],
    "instantiatesUri": [
      "http://example.org/family-member-history-questionnaire"
    ],
    "status": "completed",
    "patient": {
      "reference": "Patient/example",
      "display": "Peter Patient"
    },
    "date": "2011-03-18",
    "relationship": {
      "coding": [
        {
          "system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
          "code": "FTH",
          "display": "father"
        }
      ]
    },
    "sex": {
      "coding": [
        {
          "system": "http://hl7.org/fhir/administrative-gender",
          "code": "male",
          "display": "Male"
        }
      ]
    },
    "condition": [
      {
        "code": {
          "coding": [
            {
              "system": "http://snomed.info/sct",
              "code": "315619001",
              "display": "Myocardial Infarction"
            }
          ],
          "text": "Heart Attack"
        },
        "contributedToDeath": true,
        "onsetAge": {
          "value": 74,
          "unit": "yr",
          "system": "http://unitsofmeasure.org",
          "code": "a"
        },
        "note": [
          {
            "text": "Was fishing at the time. At least he went doing someting he loved."
          }
        ]
      }
    ]
  }'

Responses

Bodyapplication/json
resourceTypeanyrequired

This is a FamilyMemberHistory resource

Value"FamilyMemberHistory"
Example: "FamilyMemberHistory"
idstring(id)^[A-Za-z0-9\-\.]{1,64}$

Any combination of letters, numerals, "-" and ".", with a length limit of 64 characters. (This might be an integer, an unprefixed OID, UUID or any other identifier pattern that meets these constraints.) Ids are case-insensitive.

Example: "example-id"
metaobject(Meta)

The metadata about a resource. This is content in the resource that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

implicitRulesstring(uri)^\S*$

String of characters used to identify a name or a resource

Example: "https://example.org/resource"
_implicitRulesobject(Element)

Base definition for all elements in a resource.

languagestring(code)^[^\s]+(\s[^\s]+)*$

A string which has at least one character and no leading or trailing whitespace and where there is no whitespace other than single spaces in the contents

Example: "sample-code"
_languageobject(Element)

Base definition for all elements in a resource.

textobject(Narrative)

A human-readable summary of the resource conveying the essential clinical and business information for the resource.

containedArray of #Account (object) or #ActivityDefinition (object) or #AdverseEvent (object) or #AllergyIntolerance (object) or #Appointment (object) or #AppointmentResponse (object) or #AuditEvent (object) or #Basic (object) or #Binary (object) or #BiologicallyDerivedProduct (object) or #BodyStructure (object) or #Bundle (object) or #CapabilityStatement (object) or #CarePlan (object) or #CareTeam (object) or #CatalogEntry (object) or #ChargeItem (object) or #ChargeItemDefinition (object) or #Claim (object) or #ClaimResponse (object) or #ClinicalImpression (object) or #CodeSystem (object) or #Communication (object) or #CommunicationRequest (object) or #CompartmentDefinition (object) or #Composition (object) or #ConceptMap (object) or #Condition (object) or #Consent (object) or #Contract (object) or #Coverage (object) or #CoverageEligibilityRequest (object) or #CoverageEligibilityResponse (object) or #DetectedIssue (object) or #Device (object) or #DeviceDefinition (object) or #DeviceMetric (object) or #DeviceRequest (object) or #DeviceUseStatement (object) or #DiagnosticReport (object) or #DocumentManifest (object) or #DocumentReference (object) or #EffectEvidenceSynthesis (object) or #Encounter (object) or #Endpoint (object) or #EnrollmentRequest (object) or #EnrollmentResponse (object) or #EpisodeOfCare (object) or #EventDefinition (object) or #Evidence (object) or #EvidenceVariable (object) or #ExampleScenario (object) or #ExplanationOfBenefit (object) or #FamilyMemberHistory (object) or #Flag (object) or #Goal (object) or #GraphDefinition (object) or #Group (object) or #GuidanceResponse (object) or #HealthcareService (object) or #ImagingStudy (object) or #Immunization (object) or #ImmunizationEvaluation (object) or #ImmunizationRecommendation (object) or #ImplementationGuide (object) or #InsurancePlan (object) or #Invoice (object) or #Library (object) or #Linkage (object) or #List (object) or #Location (object) or #Measure (object) or #MeasureReport (object) or #Media (object) or #Medication (object) or #MedicationAdministration (object) or #MedicationDispense (object) or #MedicationKnowledge (object) or #MedicationRequest (object) or #MedicationStatement (object) or #MedicinalProduct (object) or #MedicinalProductAuthorization (object) or #MedicinalProductContraindication (object) or #MedicinalProductIndication (object) or #MedicinalProductIngredient (object) or #MedicinalProductInteraction (object) or #MedicinalProductManufactured (object) or #MedicinalProductPackaged (object) or #MedicinalProductPharmaceutical (object) or #MedicinalProductUndesirableEffect (object) or #MessageDefinition (object) or #MessageHeader (object) or #MolecularSequence (object) or #NamingSystem (object) or #NutritionOrder (object) or #Observation (object) or #ObservationDefinition (object) or #OperationDefinition (object) or #OperationOutcome (object) or #Organization (object) or #OrganizationAffiliation (object) or #Parameters (object) or #Patient (object) or #PaymentNotice (object) or #PaymentReconciliation (object) or #Person (object) or #PlanDefinition (object) or #Practitioner (object) or #PractitionerRole (object) or #Procedure (object) or #Provenance (object) or #Questionnaire (object) or #QuestionnaireResponse (object) or #RelatedPerson (object) or #RequestGroup (object) or #ResearchDefinition (object) or #ResearchElementDefinition (object) or #ResearchStudy (object) or #ResearchSubject (object) or #RiskAssessment (object) or #RiskEvidenceSynthesis (object) or #Schedule (object) or #SearchParameter (object) or #ServiceRequest (object) or #Slot (object) or #Specimen (object) or #SpecimenDefinition (object) or #StructureDefinition (object) or #StructureMap (object) or #Subscription (object) or #Substance (object) or #SubstanceNucleicAcid (object) or #SubstancePolymer (object) or #SubstanceProtein (object) or #SubstanceReferenceInformation (object) or #SubstanceSourceMaterial (object) or #SubstanceSpecification (object) or #SupplyDelivery (object) or #SupplyRequest (object) or #Task (object) or #TerminologyCapabilities (object) or #TestReport (object) or #TestScript (object) or #ValueSet (object) or #VerificationResult (object) or #VisionPrescription (object)(ResourceList)

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

extensionArray of objects(Extension)

May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

modifierExtensionArray of objects(Extension)

May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

identifierArray of objects(Identifier)

Business identifiers assigned to this family member history by the performer or other systems which remain constant as the resource is updated and propagates from server to server.

Example: [{"value":"12345"}]
instantiatesCanonicalArray of strings(canonical)

The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this FamilyMemberHistory.

Example: ["http://example.org/Profile"]
instantiatesUriArray of strings(uri)

The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this FamilyMemberHistory.

Example: ["http://example.org/family-member-history-questionnaire"]
_instantiatesUriArray of objects(Element)

Extensions for instantiatesUri

statusany

A code specifying the status of the record of the family history of a specific family member.

Enum"partial""completed""entered-in-error""health-unknown"
Example: "completed"
_statusobject(Element)

Base definition for all elements in a resource.

dataAbsentReasonobject(CodeableConcept)

A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

patientobject(Reference)required

A reference from one resource to another.

patient.​idstring

An extension object type #string.

Example: "example-string"
patient.​extensionArray of objects(#Extension)

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

patient.​referencestring

An extension object type #string.

Example: "example-string"
patient.​_referenceobject(#Element)

An extension object type #Element.

patient.​typestring

An extension object type #uri.

Example: "https://example.org/resource"
patient.​_typeobject(#Element)

An extension object type #Element.

patient.​identifierobject(#Identifier)

An extension object type #Identifier.

patient.​displaystring

An extension object type #string.

Example: "example-string"
patient.​_displayobject(#Element)

An extension object type #Element.

datestring(date-time)(dateTime)^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-...

A date, date-time or partial date (e.g. just year or year + month). If hours and minutes are specified, a time zone SHALL be populated. The format is a union of the schema types gYear, gYearMonth, date and dateTime. Seconds must be provided due to schema type constraints but may be zero-filled and may be ignored. Dates SHALL be valid dates.

Example: "2024-01-01T00:00:00Z"
_dateobject(Element)

Base definition for all elements in a resource.

namestring(string)^[ \r\n\t\S]+$

A sequence of Unicode characters

Example: "example-string"
_nameobject(Element)

Base definition for all elements in a resource.

relationshipobject(CodeableConcept)required

A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

relationship.​idstring

An extension object type #string.

Example: "example-string"
relationship.​extensionArray of objects(#Extension)

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

relationship.​codingArray of objects(#Coding)

A reference to a code defined by a terminology system.

relationship.​textstring

An extension object type #string.

Example: "example-string"
relationship.​_textobject(#Element)

An extension object type #Element.

sexobject(CodeableConcept)

A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

bornPeriodobject(Period)

A time period defined by a start and end date and optionally time.

bornDatestring^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-...

The actual or approximate date of birth of the relative.

Example: "example-string"
_bornDateobject(Element)

Base definition for all elements in a resource.

bornStringstring^[ \r\n\t\S]+$

The actual or approximate date of birth of the relative.

Example: "example-string"
_bornStringobject(Element)

Base definition for all elements in a resource.

ageAgeobject(Age)

A duration of time during which an organism (or a process) has existed.

ageRangeobject(Range)

A set of ordered Quantities defined by a low and high limit.

ageStringstring^[ \r\n\t\S]+$

The age of the relative at the time the family member history is recorded.

Example: "example-string"
_ageStringobject(Element)

Base definition for all elements in a resource.

estimatedAgeboolean(boolean)^true|false$

Value of "true" or "false"

Example: true
_estimatedAgeobject(Element)

Base definition for all elements in a resource.

deceasedBooleanboolean^true|false$

Deceased flag or the actual or approximate age of the relative at the time of death for the family member history record.

Example: true
_deceasedBooleanobject(Element)

Base definition for all elements in a resource.

deceasedAgeobject(Age)

A duration of time during which an organism (or a process) has existed.

deceasedRangeobject(Range)

A set of ordered Quantities defined by a low and high limit.

deceasedDatestring^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-...

Deceased flag or the actual or approximate age of the relative at the time of death for the family member history record.

Example: "example-string"
_deceasedDateobject(Element)

Base definition for all elements in a resource.

deceasedStringstring^[ \r\n\t\S]+$

Deceased flag or the actual or approximate age of the relative at the time of death for the family member history record.

Example: "example-string"
_deceasedStringobject(Element)

Base definition for all elements in a resource.

reasonCodeArray of objects(CodeableConcept)

Describes why the family member history occurred in coded or textual form.

reasonReferenceArray of objects(Reference)

Indicates a Condition, Observation, AllergyIntolerance, or QuestionnaireResponse that justifies this family member history event.

noteArray of objects(Annotation)

This property allows a non condition-specific note to the made about the related person. Ideally, the note would be in the condition property, but this is not always possible.

conditionArray of objects(FamilyMemberHistory_Condition)

The significant Conditions (or condition) that the family member had. This is a repeating section to allow a system to represent more than one condition per resource, though there is nothing stopping multiple resources - one per condition.

Example: [{"code":{"coding":[{"system":"http://snomed.info/sct","code":"315619001","display":"Myocardial Infarction"}],"text":"Heart Attack"},"contributedToDeath":true,"onsetAge":{"value":74,"unit":"yr","system":"http://unitsofmeasure.org","code":"a"},"note":[{"text":"Was fishing at the time. At least he went doing someting he loved."}]}]
Response
application/json
{
  "resourceType": "FamilyMemberHistory",
  "id": "father",
  "text": {
    "status": "generated",
    "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">Father died of a heart attack aged 74</div>"
  },
  "identifier": [
    { … }
  ],
  "instantiatesUri": [
    "http://example.org/family-member-history-questionnaire"
  ],
  "status": "completed",
  "patient": {
    "reference": "Patient/example",
    "display": "Peter Patient"
  },
  "date": "2011-03-18",
  "relationship": {
    "coding": [ … ]
  },
  "sex": {
    "coding": [ … ]
  },
  "condition": [
    { … }
  ]
}

Delete FHIR r4 family member history

Request

Security
bearer or bearer
Path
idstringrequired

ID of the FamilyMemberHistory to delete

siteIdstringrequired

Site identifier

curl -i -X DELETE \
  'https://docs.heydonto.com/_mock/apis/fhir/openapi/site/{siteId}/fhir/family-member-history/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

FamilyMemberHistory successfully deleted

Bodyapplication/json
statusTextstringrequired
Example: "OK"
statusnumberrequired
Example: 200
Response
application/json
{
  "statusText": "OK",
  "status": 200
}

Get FHIR r4 family member history history by ID

Request

Security
bearer or bearer
Path
siteIdstringrequired

Site identifier

idstringrequired

ID of the FamilyMemberHistory

curl -i -X GET \
  'https://docs.heydonto.com/_mock/apis/fhir/openapi/site/{siteId}/fhir/family-member-history/{id}/history' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Bodyapplication/json
resourceTypeanyrequired

This is a Bundle resource

Value"Bundle"
Example: "Bundle"
typeanyrequired

Indicates that this is a history bundle.

Value"history"
Example: "history"
entryArray of objectsrequired

A list of entries representing historical versions of the resource.

entry[].​fullUrlstringrequired
Example: "https://api.heydonto.com/family-member-history/6eca4369-7183-446e-bab7-addc609972d3"
entry[].​requestobjectrequired
entry[].​request.​methodstring
Enum"PUT""POST"
Example: "PUT"
entry[].​request.​urlstring
Example: "https://api.heydonto.com/family-member-history/6eca4369-7183-446e-bab7-addc609972d3"
entry[].​resourceobjectrequired
Example: {"resourceType":"Resource","id":"example"}
entry[].​responseobjectrequired
entry[].​response.​lastModifiedstring(date-time)
Example: "2024-10-29T01:05:22.739517+00:00"
entry[].​response.​locationstring
Example: "https://api.heydonto.com/family-member-history/6eca4369-7183-446e-bab7-addc609972d3/_history/MTczMDE2MzkyMjczOTUxNzAwMA"
entry[].​response.​statusstring
Example: "200 OK"
totalintegerrequired
Example: 2
Response
application/json
{
  "resourceType": "Bundle",
  "type": "history",
  "entry": [
    { … }
  ],
  "total": 2
}

Flag

Operations

Goal

Operations

GraphDefinition

Operations

Group

Operations

GuidanceResponse

Operations

HealthcareService

Operations

ImagingStudy

Operations

Immunization

Operations

ImmunizationEvaluation

Operations

ImmunizationRecommendation

Operations

ImplementationGuide

Operations

InsurancePlan

Operations

Invoice

Operations

Library

Operations

Linkage

Operations

List

Operations

Location

Operations

Measure

Operations

MeasureReport

Operations

Media

Operations

Medication

Operations

MedicationAdministration

Operations

MedicationDispense

Operations

MedicationKnowledge

Operations

MedicationRequest

Operations

MedicationStatement

Operations

MedicinalProduct

Operations

MedicinalProductAuthorization

Operations

MedicinalProductContraindication

Operations

MedicinalProductIndication

Operations

MedicinalProductIngredient

Operations

MedicinalProductInteraction

Operations

MedicinalProductManufactured

Operations

MedicinalProductPackaged

Operations

MedicinalProductPharmaceutical

Operations

MedicinalProductUndesirableEffect

Operations

MessageDefinition

Operations

MessageHeader

Operations

MolecularSequence

Operations

NamingSystem

Operations

NutritionOrder

Operations

Observation

Operations

ObservationDefinition

Operations

OperationDefinition

Operations

OperationOutcome

Operations

Organization

Operations

OrganizationAffiliation

Operations

Parameters

Operations

Patient

Operations

PaymentNotice

Operations

PaymentReconciliation

Operations

Person

Operations

PlanDefinition

Operations

Practitioner

Operations

PractitionerRole

Operations

Procedure

Operations

Provenance

Operations

Questionnaire

Operations

QuestionnaireResponse

Operations

RelatedPerson

Operations

RequestGroup

Operations

ResearchDefinition

Operations

ResearchElementDefinition

Operations

ResearchStudy

Operations

ResearchSubject

Operations

RiskAssessment

Operations

RiskEvidenceSynthesis

Operations

Schedule

Operations

SearchParameter

Operations

ServiceRequest

Operations

Slot

Operations

Specimen

Operations

SpecimenDefinition

Operations

StructureDefinition

Operations

StructureMap

Operations

Subscription

Operations

Substance

Operations

SubstanceNucleicAcid

Operations

SubstancePolymer

Operations

SubstanceProtein

Operations

SubstanceReferenceInformation

Operations

SubstanceSourceMaterial

Operations

SubstanceSpecification

Operations

SupplyDelivery

Operations

SupplyRequest

Operations

Task

Operations

TerminologyCapabilities

Operations

TestReport

Operations

TestScript

Operations

ValueSet

Operations

VerificationResult

Operations

VisionPrescription

Operations