R4 Draft for Comment

This page is part of the FHIR Specification (v3.2.0: R4 Ballot 1). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3

Compartmentdefinition-relatedperson.json

FHIR Infrastructure Work GroupMaturity Level: N/ABallot Status: Informative

Raw JSON (canonical form)

Compartment Definition for relatedPerson

{
  "resourceType": "CompartmentDefinition",
  "id": "relatedPerson",
  "text": {
    "status": "generated",
    "div": "<div>!-- Snipped for Brevity --></div>"
  },
  "url": "http://hl7.org/fhir/CompartmentDefinition/relatedPerson",
  "name": "Base FHIR compartment definition for RelatedPerson",
  "status": "draft",
  "experimental": true,
  "date": "2017-12-20T15:52:34+11:00",
  "publisher": "FHIR Project Team",
  "contact": [
    {
      "telecom": [
        {
          "system": "url",
          "value": "http://hl7.org/fhir"
        }
      ]
    }
  ],
  "description": "There is an instance of the relatedPerson compartment for each relatedPerson resource, and the identity of the compartment is the same as the relatedPerson. The set of resources associated with a particular 'related person'",
  "code": "RelatedPerson",
  "search": true,
  "resource": [
    {
      "code": "Account"
    },
    {
      "code": "ActivityDefinition"
    },
    {
      "code": "AdverseEvent",
      "param": [
        "recorder"
      ]
    },
    {
      "code": "AllergyIntolerance",
      "param": [
        "asserter"
      ]
    },
    {
      "code": "Appointment",
      "param": [
        "actor"
      ]
    },
    {
      "code": "AppointmentResponse",
      "param": [
        "actor"
      ]
    },
    {
      "code": "AuditEvent"
    },
    {
      "code": "Basic",
      "param": [
        "author"
      ]
    },
    {
      "code": "Binary"
    },
    {
      "code": "BiologicallyDerivedProduct"
    },
    {
      "code": "BodyStructure"
    },
    {
      "code": "Bundle"
    },
    {
      "code": "CapabilityStatement"
    },
    {
      "code": "CarePlan",
      "param": [
        "performer"
      ]
    },
    {
      "code": "CareTeam",
      "param": [
        "participant"
      ]
    },
    {
      "code": "ChargeItem",
      "param": [
        "enterer",
        "participant-actor"
      ]
    },
    {
      "code": "Claim",
      "param": [
        "payee"
      ]
    },
    {
      "code": "ClaimResponse"
    },
    {
      "code": "ClinicalImpression"
    },
    {
      "code": "CodeSystem"
    },
    {
      "code": "Communication",
      "param": [
        "sender",
        "recipient"
      ]
    },
    {
      "code": "CommunicationRequest",
      "param": [
        "sender",
        "recipient",
        "requester"
      ]
    },
    {
      "code": "CompartmentDefinition"
    },
    {
      "code": "Composition",
      "param": [
        "author"
      ]
    },
    {
      "code": "ConceptMap"
    },
    {
      "code": "Condition",
      "param": [
        "asserter"
      ]
    },
    {
      "code": "Consent"
    },
    {
      "code": "Contract"
    },
    {
      "code": "Coverage",
      "param": [
        "policy-holder",
        "subscriber",
        "payor"
      ]
    },
    {
      "code": "DetectedIssue"
    },
    {
      "code": "Device"
    },
    {
      "code": "DeviceComponent"
    },
    {
      "code": "DeviceMetric"
    },
    {
      "code": "DeviceRequest"
    },
    {
      "code": "DeviceUseStatement"
    },
    {
      "code": "DiagnosticReport"
    },
    {
      "code": "DocumentManifest",
      "param": [
        "agent"
      ]
    },
    {
      "code": "DocumentReference",
      "param": [
        "agent"
      ]
    },
    {
      "code": "EligibilityRequest"
    },
    {
      "code": "EligibilityResponse"
    },
    {
      "code": "Encounter",
      "param": [
        "participant"
      ]
    },
    {
      "code": "Endpoint"
    },
    {
      "code": "EnrollmentRequest"
    },
    {
      "code": "EnrollmentResponse"
    },
    {
      "code": "EntryDefinition"
    },
    {
      "code": "EpisodeOfCare"
    },
    {
      "code": "EventDefinition"
    },
    {
      "code": "ExampleScenario"
    },
    {
      "code": "ExpansionProfile"
    },
    {
      "code": "ExplanationOfBenefit",
      "param": [
        "payee"
      ]
    },
    {
      "code": "FamilyMemberHistory"
    },
    {
      "code": "Flag"
    },
    {
      "code": "Goal"
    },
    {
      "code": "GraphDefinition"
    },
    {
      "code": "Group"
    },
    {
      "code": "GuidanceResponse"
    },
    {
      "code": "HealthcareService"
    },
    {
      "code": "ImagingStudy"
    },
    {
      "code": "Immunization"
    },
    {
      "code": "ImmunizationEvaluation"
    },
    {
      "code": "ImmunizationRecommendation"
    },
    {
      "code": "ImplementationGuide"
    },
    {
      "code": "ImplementationGuideInput"
    },
    {
      "code": "ImplementationGuideOutput"
    },
    {
      "code": "Invoice",
      "param": [
        "recipient"
      ]
    },
    {
      "code": "ItemInstance"
    },
    {
      "code": "Library"
    },
    {
      "code": "Linkage"
    },
    {
      "code": "List"
    },
    {
      "code": "Location"
    },
    {
      "code": "Measure"
    },
    {
      "code": "MeasureReport"
    },
    {
      "code": "Media"
    },
    {
      "code": "Medication"
    },
    {
      "code": "MedicationAdministration",
      "param": [
        "performer"
      ]
    },
    {
      "code": "MedicationDispense"
    },
    {
      "code": "MedicationRequest"
    },
    {
      "code": "MedicationStatement",
      "param": [
        "source"
      ]
    },
    {
      "code": "MedicinalProduct"
    },
    {
      "code": "MedicinalProductAuthorization"
    },
    {
      "code": "MedicinalProductClinicals"
    },
    {
      "code": "MedicinalProductDeviceSpec"
    },
    {
      "code": "MedicinalProductIngredient"
    },
    {
      "code": "MedicinalProductPackaged"
    },
    {
      "code": "MedicinalProductPharmaceutical"
    },
    {
      "code": "MessageDefinition"
    },
    {
      "code": "MessageHeader"
    },
    {
      "code": "NamingSystem"
    },
    {
      "code": "NutritionOrder"
    },
    {
      "code": "Observation",
      "param": [
        "performer"
      ]
    },
    {
      "code": "ObservationDefinition"
    },
    {
      "code": "OccupationalData"
    },
    {
      "code": "OperationDefinition"
    },
    {
      "code": "OperationOutcome"
    },
    {
      "code": "Organization"
    },
    {
      "code": "OrganizationRole"
    },
    {
      "code": "Patient",
      "param": [
        "link"
      ]
    },
    {
      "code": "PaymentNotice"
    },
    {
      "code": "PaymentReconciliation"
    },
    {
      "code": "Person",
      "param": [
        "link"
      ]
    },
    {
      "code": "PlanDefinition"
    },
    {
      "code": "Practitioner"
    },
    {
      "code": "PractitionerRole"
    },
    {
      "code": "Procedure",
      "param": [
        "performer"
      ]
    },
    {
      "code": "ProcessRequest"
    },
    {
      "code": "ProcessResponse"
    },
    {
      "code": "ProductPlan"
    },
    {
      "code": "Provenance",
      "param": [
        "agent"
      ]
    },
    {
      "code": "Questionnaire"
    },
    {
      "code": "QuestionnaireResponse",
      "param": [
        "author",
        "source"
      ]
    },
    {
      "code": "RelatedPerson",
      "param": [
        "{def}"
      ]
    },
    {
      "code": "RequestGroup",
      "param": [
        "participant"
      ]
    },
    {
      "code": "ResearchStudy"
    },
    {
      "code": "ResearchSubject"
    },
    {
      "code": "RiskAssessment"
    },
    {
      "code": "Schedule",
      "param": [
        "actor"
      ]
    },
    {
      "code": "SearchParameter"
    },
    {
      "code": "Sequence"
    },
    {
      "code": "ServiceDefinition"
    },
    {
      "code": "ServiceRequest",
      "param": [
        "performer"
      ]
    },
    {
      "code": "Slot"
    },
    {
      "code": "Specimen"
    },
    {
      "code": "SpecimenDefinition"
    },
    {
      "code": "StructureDefinition"
    },
    {
      "code": "StructureMap"
    },
    {
      "code": "Subscription"
    },
    {
      "code": "Substance"
    },
    {
      "code": "SubstancePolymer"
    },
    {
      "code": "SubstanceReferenceInformation"
    },
    {
      "code": "SubstanceSpecification"
    },
    {
      "code": "SupplyDelivery"
    },
    {
      "code": "SupplyRequest",
      "param": [
        "requester"
      ]
    },
    {
      "code": "Task"
    },
    {
      "code": "TerminologyCapabilities"
    },
    {
      "code": "TestReport"
    },
    {
      "code": "TestScript"
    },
    {
      "code": "UserSession",
      "param": [
        "user"
      ]
    },
    {
      "code": "ValueSet"
    },
    {
      "code": "VerificationResult"
    },
    {
      "code": "VisionPrescription"
    }
  ]
}

Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.