Data collection property ............. in .............................. has an annotation that isn't a data object or is missing an annotation

[ivanwilliammd]

Hello,

My name is Ivan, and I'm quite interested in using this library for constructing FHIR R4 API which needs some DTO
I am using Spatie/Laravel-data v2 on PHP 8.1 Laravel 8.

It's quite confusing/frustating as I am out of ammo to debug and the error response is not pointing the problem in more detail :

Summary

I have called the classes directly without using DataCollection

        #[Nullable]
        public ?FhirComplex\FhirIdentifier $identifier,
        #[Nullable]
        public ?FhirComplex\FhirCoding $class,

Error shown

"message": "App\\FhirDataTypes\\FhirEncounter::__construct(): Argument #2 ($identifier) must be of type ?App\\FhirDataTypes\\FhirComplex\\FhirIdentifier, array given, called in D:\\WebProgramming\\ivanmd_fhir\\vendor\\spatie\\laravel-data\\src\\Resolvers\\DataFromArrayResolver.php on line 60",
    "exception": "TypeError",

    "message": "App\\FhirDataTypes\\FhirEncounter::__construct(): Argument #4 ($class) must be of type ?App\\FhirDataTypes\\FhirComplex\\FhirCoding, array given, called in D:\\WebProgramming\\ivanmd_fhir\\vendor\\spatie\\laravel-data\\src\\Resolvers\\DataFromArrayResolver.php on line 60",
    "exception": "TypeError",

Second attempt : to use DataCollection

        #[DataCollectionOf(FhirComplex\FhirIdentifier::class)]
        public ?DataCollection $identifier,

        #[DataCollectionOf(FhirComplex\FhirCoding::class)]
        public ?DataCollection $class,

Error shown

    "message": "Data collection property `identifier` in `App\\FhirDataTypes\\FhirEncounter` has an annotation that isn't a data object or is missing an annotation",
    "exception": "Spatie\\LaravelData\\Exceptions\\CannotFindDataClass",

    "message": "Data collection property `class` in `App\\FhirDataTypes\\FhirEncounter` has an annotation that isn't a data object or is missing an annotation",
    "exception": "Spatie\\LaravelData\\Exceptions\\CannotFindDataClass",

---

Complete Snippet

First of all, I have created a DTO template for Complex Datatype such as the following (FhirComplex.php): --> referring to this https://www.hl7.org/fhir/datatypes.html

<?php

namespace App\FhirDataTypes;

use Spatie\LaravelData\Data;
use Spatie\LaravelData\DataCollection;
use Carbon\CarbonImmutable;


class FhirAttachment extends Data
{
    public function __construct(
        #[Nullable]
        public ?string $contentType,
        #[Nullable]
        public ?string $language,
        #[Nullable]
        public ?base64_encode $data,
        #[Nullable]
        public ?string $url,
        #[Nullable]
        public ?int $size,
        #[Nullable]
        public ?base64_encode $hash,
        #[Nullable]
        public ?string $title,
        #[Nullable]
        public ?CarbonImmutable $creation,
    ) {
    }
}

class FhirCoding extends Data
{
    public function __construct(
        #[Nullable]
        public ?string $system,
        #[Nullable]
        public ?string $version,
        #[Nullable]
        public ?string $code,
        #[Nullable]
        public ?string $display,
        #[Nullable]
        public ?bool $userSelected,
    ) {
    }
}

class FhirCodeableConcept extends Data
{
    public function __construct(
        #[Nullable]
        public ?string $text,
        #[Nullable]
        public ?FhirCoding $coding,
    ) {
    }
}

class FhirQuantity extends Data
{
    public function __construct(
        #[Nullable]
        public ?string $value,
        #[Nullable]
        public ?string $comparator,
        #[Nullable]
        public ?string $unit,
        #[Nullable]
        public ?string $system,
        #[Nullable]
        public ?string $code,
    ) {
    }
}

class FhirMoney extends Data
{
    public function __construct(
        #[Nullable]
        public ?decimal $value,
        #[Nullable]
        public ?string $currency,
    ) {
    }
}

class FhirRange extends Data
{
    public function __construct(
        #[Nullable]
        public ?FhirSimpleQuantity $low,
        #[Nullable]
        public ?FhirSimpleQuantity $high,
    ) {
    }
}

class FhirRatio extends Data
{
    public function __construct(
        #[Nullable]
        public ?FhirQuantity $numerator,
        #[Nullable]
        public ?FhirQuantity $denominator,
    ) {
    }
}

class FhirRatioRange extends Data{
    public function __construct(
        #[Nullable]
        public ?FhirSimpleQuantity $lowNumerator,
        #[Nullable]
        public ?FhirSimpleQuantity $highNumerator,
        #[Nullable]
        public ?FhirSimpleQuantity $denominator,
    ) {
    }
}

class FhirPeriod extends Data
{
    public function __construct(
        #[Nullable]
        public ?CarbonImmutable $start,
        #[Nullable]
        public ?CarbonImmutable $end,
    ) {
    }
}

class FhirSampledData extends Data
{
    public function __construct(
        #[Required]
        public FhirSimpleQuantity $origin,
        #[Required]
        public decimal $period,
        #[Nullable]
        public ?decimal $factor,
        #[Nullable]
        public ?decimal $lowerLimit,
        #[Nullable]
        public ?decimal $upperLimit,
        #[Required]
        public int $dimensions,
        #[Nullable]
        public ?string $data,
    ) {
    }
}

class FhirIdentifier extends Data
{
    public function __construct(
        #[Nullable]
        public ?string $use,
        #[Nullable]
        public ?FhirCodeableConcept $type,
        #[Required]
        public string $system,
        #[Nullable]
        public ?string $value,
        #[Nullable]
        public ?FhirPeriod $period,
        #[Nullable]
        public ?FhirReference $assigner,
    ) {
    }

}

class FhirReference extends Data
{
    public function __construct(
        #[Nullable]
        public ?string $reference,
        #[Nullable]
        public ?string $type,
        #[Nullable]
        public ?FhirIdentifier $identifier,
        #[Nullable]
        public ?string $display,
    ) {
    }
}

class FhirHumanName extends Data
{
    public function __construct(
        #[Nullable]
        public ?string $use,
        #[Nullable]
        public ?string $text,
        #[Nullable]
        public ?string $family,
        #[Nullable]
        public ?string $given,
        #[Nullable]
        public ?string $prefix,
        #[Nullable]
        public ?string $suffix,
        #[Nullable]
        public ?FhirPeriod $period,
    ) {
    }
}

class FhirAddress extends Data
{
    public function __construct(
        #[Nullable]
        public ?string $use,
        #[Nullable]
        public ?string $type,
        #[Nullable]
        public ?string $text,
        #[Nullable]
        public ?string $line,
        #[Nullable]
        public ?string $city,
        #[Nullable]
        public ?string $district,
        #[Nullable]
        public ?string $state,
        #[Nullable]
        public ?string $postalCode,
        #[Nullable]
        public ?string $country,
        #[Nullable]
        public ?FhirPeriod $period,
    ) {
    }
}

class FhirContactPoint extends Data
{
    public function __construct(
        #[Nullable]
        public ?string $system,
        #[Nullable]
        public ?string $value,
        #[Nullable]
        public ?string $use,
        #[Nullable]
        public ?int $rank,
        #[Nullable]
        public ?FhirPeriod $period,
    ) {
    }
}

class FhirTiming extends Data
{
    public function __construct(
        #[Nullable]
        public ?CarbonImmutable $event,
        #[Nullable]
        public ?FhirRepeatElement $repeat,
        #[Nullable]
        public ?FhirCodeableConcept $code,
    ) {
    }
}

class FhirRepeatElement extends Data
{
    public function __construct(
        #[Nullable]
        public ?FhirDuration $boundsDuration,
        #[Nullable]
        public ?FhirRange $boundsRange,
        #[Nullable]
        public ?FhirPeriod $boundsPeriod,
        #[Nullable]
        public ?int $count,
        #[Nullable]
        public ?int $countMax,
        #[Nullable]
        public ?decimal $duration,
        #[Nullable]
        public ?decimal $durationMax,
        #[Nullable]
        public ?string $durationUnit,
        #[Nullable]
        public ?int $frequency,
        #[Nullable]
        public ?int $frequencyMax,
        #[Nullable]
        public ?decimal $period,
        #[Nullable]
        public ?decimal $periodMax,
        #[Nullable]
        public ?string $periodUnit,
        #[Nullable]
        public ?string $dayOfWeek,
        #[Nullable]
        public ?time $timeOfDay,
        #[Nullable]
        public ?int $when,
        #[Nullable]
        public ?int $offset,
    ) {
    }
}

class FhirSignature extends Data
{
    public function __construct(
        #[Required]
        public FhirCoding $type,
        #[Required]
        public CarbonImmutable $when,
        #[Required]
        public FhirReference $who,
        #[Nullable]
        public ?FhirReference $onBehalfOf,
        #[Nullable]
        public ?string $targetFormat,
        #[Nullable]
        public ?string $sigFormat,
        #[Nullable]
        public ?base64_encode $data,
    ) {
    }
}

class FhirAnnotation extends Data
{
    public function __construct(
        #[Nullable]
        public ?FhirReference $authorReference,
        #[Nullable]
        public ?string $authorString,
        #[Nullable]
        public ?CarbonImmutable $time,
        #[Required]
        public longText $text,
    ) {
    }
}

?>

Second For parsing the json I create some custom DTO referring to other Data Classes (FhirEncounter.type):

<?php

namespace App\FhirDataTypes;

use Spatie\LaravelData\Data;
use Spatie\LaravelData\DataCollection;
use Carbon\CarbonImmutable;

class FhirEncounter extends Data{
    public function __construct(

        #[Rule('required|regex:/^Encounter$/')]
        public string $resourceType,
        #[DataCollectionOf(FhirComplex\FhirIdentifier::class)]
        public ?DataCollection $identifier,
        #[Required]
        public string $status,
        #[Nullable]
        public ?FhirEncounterStatusHistory $statusHistory,
        #[DataCollectionOf(FhirComplex\FhirCoding::class)]
        public DataCollection $class,
        #[Nullable]
        public ?FhirEncounterClassHistory $classHistory,
        #[Nullable]
        public ?FhirComplex\FhirCodableConcept $type,
        #[Nullable]
        public ?FhirComplex\FhirCodableConcept $serviceType,
        #[Nullable]
        public ?FhirComplex\FhirCodableConcept $priority,
        #[Nullable]
        public ?FhirComplex\FhirReference $subject,
        #[Nullable]
        public ?FhirComplex\FhirReference $episodeOfCare,
        #[Nullable]
        public ?FhirComplex\FhirReference $basedOn,
        #[Required]
        public FhirEncounterParticipant $participant,
        #[Nullable]
        public ?FhirComplex\FhirReference $appointment,
        #[Nullable]
        public ?FhirComplex\FhirPeriod $period,
        #[Nullable]
        public ?FhirComplex\FhirDuration $length,
        #[Nullable]
        public ?FhirComplex\FhirCodableConcept $reasonCode,
        #[Nullable]
        public ?FhirComplex\FhirReference $reasonReference,
        #[Nullable]
        public ?FhirEncounterDiagnosis $diagnosis,
        #[Nullable]
        public ?FhirComplex\FhirReference $account,
        #[Nullable]
        public ?FhirComplex\FhirEncounterHospitalization $hospitalization,
        #[Nullable]
        public ?FhirEncounterLocation $location,
        #[Nullable]
        public ?FhirComplex\FhirReference $serviceProvider,
        #[Nullable]
        public ?FhirComplex\FhirReference $partOf,
    ) {
    }
}

class FhirEncounterStatusHistory extends Data{
    public function __construct(
        #[Required]
        public string $status,
        #[Required]
        public FhirComplex\FhirPeriod $period,
    ) {
    }
}

class FhirEncounterClassHistory extends Data{
    public function __construct(
        #[Required]
        public string $class,
        #[Required]
        public FhirComplex\FhirPeriod $period,
    ) {
    }
}

class FhirEncounterParticipant extends Data{
    public function __construct(
        #[Nullable]
        public ?FhirComplex\FhirCodeableConcept $type,
        #[Nullable]
        public ?FhirComplex\FhirPeriod $period,
        #[Nullable]
        public ?FhirComplex\FhirReference $individual,
    ) {
    }
}

class FhirEncounterDiagnosis extends Data{
    public function __construct(
        #[Required]
        public FhirComplex\FhirReference $condition,
        #[Nullable]
        public ?FhirComplex\FhirCodeableConcept $use,
        #[Nullable]
        public ?int $rank,
    ) {
    }
}

class FhirEncounterHospitalization extends Data{
    public function __construct(
        #[DataCollectionOf(FhirComplex\FhirIdentifier::class)]
        public ?DataCollection $preAdmissionIdentifier,
        #[Nullable]
        public ?FhirComplex\FhirReference $origin,
        #[Nullable]
        public ?FhirComplex\FhirCodeableConcept $admitSource,
        #[Nullable]
        public ?FhirComplex\FhirCodeableConcept $reAdmission,
        #[Nullable]
        public ?FhirComplex\FhirCodeableConcept $dietPreference,
        #[Nullable]
        public ?FhirComplex\FhirCodeableConcept $specialCourtesy,
        #[Nullable]
        public ?FhirComplex\FhirCodeableConcept $specialArrangement,
        #[Nullable]
        public ?FhirComplex\FhirReference $destination,
        #[Nullable]
        public ?FhirComplex\FhirCodeableConcept $dischargeDisposition,
    ) {
    }
}

class FhirEncounterLocation extends Data{
    public function __construct(
        public FhirComplex\FhirReference $location,
        public string $status,
        public FhirComplex\FhirCodeableConcept $physicalType,
        public FhirComplex\FhirPeriod $period,
    ) {
    }
}

?>

I have used read the documentation using laravel-data DTO as requests

    public function store(FhirEncounter $request)
    {
        ..... (storing method)
    }

And I'm using this following json payload to test in Postman :

{
  "resourceType": "Encounter",
  "id": "f003",
  "text": {
    "status": "generated",
    "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p><b>Generated Narrative</b></p><div style=\"display: inline-block; background-color: #d9e0e7; padding: 6px; margin: 4px; border: 1px solid #8da1b4; border-radius: 5px; line-height: 60%\"><p style=\"margin-bottom: 0px\">Resource &quot;f003&quot; </p></div><p><b>identifier</b>: id: v6751 (OFFICIAL)</p><p><b>status</b>: finished</p><p><b>class</b>: ambulatory (Details: http://terminology.hl7.org/CodeSystem/v3-ActCode code AMB = 'ambulatory', stated as 'ambulatory')</p><p><b>type</b>: Patient-initiated encounter <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> (<a href=\"https://browser.ihtsdotools.org/\">SNOMED CT</a>#270427003)</span></p><p><b>priority</b>: Non-urgent ear, nose and throat admission <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> (<a href=\"https://browser.ihtsdotools.org/\">SNOMED CT</a>#103391001)</span></p><p><b>subject</b>: <a href=\"patient-f001.html\">Patient/f001: P. van de Heuvel</a> &quot;Pieter VAN DE HEUVEL&quot;</p><h3>Participants</h3><table class=\"grid\"><tr><td>-</td><td><b>Individual</b></td></tr><tr><td>*</td><td><a href=\"practitioner-f001.html\">Practitioner/f001: E.M. van den Broek</a> &quot;Eric VAN DEN BROEK&quot;</td></tr></table><p><b>reasonCode</b>: Retropharyngeal abscess <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> (<a href=\"https://browser.ihtsdotools.org/\">SNOMED CT</a>#18099001)</span></p><h3>Hospitalizations</h3><table class=\"grid\"><tr><td>-</td><td><b>PreAdmissionIdentifier</b></td><td><b>AdmitSource</b></td><td><b>DischargeDisposition</b></td></tr><tr><td>*</td><td>id: 93042 (OFFICIAL)</td><td>Referral by physician <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> (<a href=\"https://browser.ihtsdotools.org/\">SNOMED CT</a>#305956004)</span></td><td>Discharge to home <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> (<a href=\"https://browser.ihtsdotools.org/\">SNOMED CT</a>#306689006)</span></td></tr></table><p><b>serviceProvider</b>: <a href=\"organization-f001.html\">Organization/f001</a> &quot;Burgers University Medical Center&quot;</p></div>"
  },
  "status": "finished",
  "class": {
    "system": "http://terminology.hl7.org/CodeSystem/v3-ActCode",
    "code": "AMB",
    "display": "ambulatory"
  },
  "type": [
    {
      "coding": [
        {
          "system": "http://snomed.info/sct",
          "code": "270427003",
          "display": "Patient-initiated encounter"
        }
      ]
    }
  ],
  "priority": {
    "coding": [
      {
        "system": "http://snomed.info/sct",
        "code": "103391001",
        "display": "Non-urgent ear, nose and throat admission"
      }
    ]
  },
  "subject": {
    "reference": "Patient/f001",
    "display": "P. van de Heuvel"
  },
  "participant": [
    {
      "individual": {
        "reference": "Practitioner/f001",
        "display": "E.M. van den Broek"
      }
    }
  ],
  "length": {
    "value": 90,
    "unit": "min",
    "system": "http://unitsofmeasure.org",
    "code": "min"
  },
  "reasonCode": [
    {
      "coding": [
        {
          "system": "http://snomed.info/sct",
          "code": "18099001",
          "display": "Retropharyngeal abscess"
        }
      ]
    }
  ],
  "hospitalization": {
    "preAdmissionIdentifier": {
      "use": "official",
      "system": "http://www.bmc.nl/zorgportal/identifiers/pre-admissions",
      "value": "93042"
    },
    "admitSource": {
      "coding": [
        {
          "system": "http://snomed.info/sct",
          "code": "305956004",
          "display": "Referral by physician"
        }
      ]
    },
    "dischargeDisposition": {
      "coding": [
        {
          "system": "http://snomed.info/sct",
          "code": "306689006",
          "display": "Discharge to home"
        }
      ]
    }
  },
  "serviceProvider": {
    "reference": "Organization/f001"
  }
}

and this is the first error that I got

{
    "message": "Data collection property `identifier` in `App\\FhirDataTypes\\FhirEncounter` has an annotation that isn't a data object or is missing an annotation",
    "exception": "Spatie\\LaravelData\\Exceptions\\CannotFindDataClass",
}

When I tried to comment this part in FhirEncounter.php for Identifier

        #[DataCollectionOf(FhirComplex\FhirIdentifier::class)]
        public ?DataCollection $identifier,

I got another error from Classes

"message": "Data collection property `class` in `App\\FhirDataTypes\\FhirEncounter` has an annotation that isn't a data object or is missing an annotation",
    "exception": "Spatie\\LaravelData\\Exceptions\\CannotFindDataClass",

Thank you very much for your time reading this and really appreciate any helps / hints on this...

CC: @rubenvanassche

[rubenvanassche]

I also have no idea immediately what's happening.

First, try to upgrade to v3 and see if that fixes the problem.

The message is shown when a docblock is missing a correct annotation, but since you're using DataCollectionOfthis shouldn't be an issue. To be sure check if that one is imported properly. You basically shouldn't pass this piece of code:

https://github.com/spatie/laravel-data/blob/9c58880dd22d342ee9e371c87df8a6d632bed6d5/src/Support/DataType.php#L237-L236

[ivanwilliammd]

I see well noted @rubenvanassche, will try it on my other projects, as currently I'm currently used laravel 8, and unable to update to v3 just now

[daggemarren]

Seems like you forgot to add "use Spatie\LaravelData\Attributes\DataCollectionOf;"