# Patient - Medtech ALEX® AU Implementation Guide v1.0.0

* [**Table of Contents**](toc.md)
* [**Artifacts Summary**](artifacts.md)
* **Patient**

## Resource Profile: Patient 

| | |
| :--- | :--- |
| *Official URL*:https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/alex-patient | *Version*:1.0.0 |
| Active as of 2026-01-12 | *Computable Name*:AlexPatient |

 
The Patient resource exposed by ALEX 

**Usages:**

* Derived from this Profile: [Patient IPS Profile](StructureDefinition-alex-patient-ips.md)
* Use this Profile: [Patient Bundle](StructureDefinition-patient-search-bundle.md)
* Examples for this Profile: [Patient/patient-full-example](Patient-patient-full-example.md) and [Patient/patient-minimum-example](Patient-patient-minimum-example.md)

You can also check for [usages in the FHIR IG Statistics](https://packages2.fhir.org/xig/medtechglobal.fhir.alex|current/StructureDefinition/alex-patient)

### Formal Views of Profile Content

 [Description of Profiles, Differentials, Snapshots and how the different presentations work](http://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#structure-definitions). 

 

Other representations of profile: [CSV](StructureDefinition-alex-patient.csv), [Excel](StructureDefinition-alex-patient.xlsx), [Schematron](StructureDefinition-alex-patient.sch) 



## Resource Content

```json
{
  "resourceType" : "StructureDefinition",
  "id" : "alex-patient",
  "url" : "https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/alex-patient",
  "version" : "1.0.0",
  "name" : "AlexPatient",
  "title" : "Patient",
  "status" : "active",
  "date" : "2026-01-12T22:43:00+00:00",
  "publisher" : "Medtech Global",
  "contact" : [
    {
      "name" : "Medtech Global",
      "telecom" : [
        {
          "system" : "url",
          "value" : "https://medtechglobal.com/au/"
        },
        {
          "system" : "email",
          "value" : "supportau@medtechglobal.com"
        }
      ]
    },
    {
      "name" : "Medtech Support",
      "telecom" : [
        {
          "system" : "email",
          "value" : "supportau@medtechglobal.com",
          "use" : "work"
        }
      ]
    }
  ],
  "description" : "The Patient resource exposed by ALEX",
  "jurisdiction" : [
    {
      "coding" : [
        {
          "system" : "http://unstats.un.org/unsd/methods/m49/m49.htm",
          "code" : "001",
          "display" : "World"
        }
      ]
    }
  ],
  "fhirVersion" : "4.0.1",
  "mapping" : [
    {
      "identity" : "rim",
      "uri" : "http://hl7.org/v3",
      "name" : "RIM Mapping"
    },
    {
      "identity" : "cda",
      "uri" : "http://hl7.org/v3/cda",
      "name" : "CDA (R2)"
    },
    {
      "identity" : "w5",
      "uri" : "http://hl7.org/fhir/fivews",
      "name" : "FiveWs Pattern Mapping"
    },
    {
      "identity" : "v2",
      "uri" : "http://hl7.org/v2",
      "name" : "HL7 v2 Mapping"
    },
    {
      "identity" : "loinc",
      "uri" : "http://loinc.org",
      "name" : "LOINC code for the element"
    }
  ],
  "kind" : "resource",
  "abstract" : false,
  "type" : "Patient",
  "baseDefinition" : "http://hl7.org.au/fhir/StructureDefinition/au-patient",
  "derivation" : "constraint",
  "differential" : {
    "element" : [
      {
        "id" : "Patient.extension",
        "path" : "Patient.extension",
        "min" : 1
      },
      {
        "id" : "Patient.extension:birthPlace",
        "path" : "Patient.extension",
        "sliceName" : "birthPlace",
        "max" : "0"
      },
      {
        "id" : "Patient.extension:indigenousStatus",
        "path" : "Patient.extension",
        "sliceName" : "indigenousStatus",
        "mustSupport" : true
      },
      {
        "id" : "Patient.extension:closingTheGapRegistration",
        "path" : "Patient.extension",
        "sliceName" : "closingTheGapRegistration",
        "max" : "0"
      },
      {
        "id" : "Patient.extension:mothersMaidenName",
        "path" : "Patient.extension",
        "sliceName" : "mothersMaidenName",
        "max" : "0"
      },
      {
        "id" : "Patient.extension:interpreterRequired",
        "path" : "Patient.extension",
        "sliceName" : "interpreterRequired",
        "max" : "0"
      },
      {
        "id" : "Patient.extension:dateOfArrival",
        "path" : "Patient.extension",
        "sliceName" : "dateOfArrival",
        "max" : "0"
      },
      {
        "id" : "Patient.extension:genderIdentity",
        "path" : "Patient.extension",
        "sliceName" : "genderIdentity",
        "max" : "0"
      },
      {
        "id" : "Patient.extension:sexAtBirth",
        "path" : "Patient.extension",
        "sliceName" : "sexAtBirth",
        "min" : 1,
        "max" : "1",
        "type" : [
          {
            "code" : "Extension",
            "profile" : [
              "https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/sex-at-birth"
            ]
          }
        ],
        "mustSupport" : true
      },
      {
        "id" : "Patient.extension:patientRegistrationStatus",
        "path" : "Patient.extension",
        "sliceName" : "patientRegistrationStatus",
        "short" : "Patient registration status (Medtech – required)",
        "min" : 0,
        "max" : "1",
        "type" : [
          {
            "code" : "Extension",
            "profile" : [
              "https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/patient-registration-status"
            ]
          }
        ],
        "mustSupport" : true
      },
      {
        "id" : "Patient.extension:patientRegistrationStatus.value[x]",
        "path" : "Patient.extension.value[x]",
        "comment" : "User-defined codes managed in the PMS; canonical system only; code list not published in this IG."
      },
      {
        "id" : "Patient.extension:patientLocation",
        "path" : "Patient.extension",
        "sliceName" : "patientLocation",
        "min" : 0,
        "max" : "1",
        "type" : [
          {
            "code" : "Extension",
            "profile" : [
              "https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/patient-location"
            ]
          }
        ],
        "mustSupport" : true
      },
      {
        "id" : "Patient.extension:patientEthnicity",
        "path" : "Patient.extension",
        "sliceName" : "patientEthnicity",
        "min" : 0,
        "max" : "1",
        "type" : [
          {
            "code" : "Extension",
            "profile" : [
              "https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/patient-ethnicity"
            ]
          }
        ],
        "mustSupport" : true
      },
      {
        "id" : "Patient.extension:isAccountHolder",
        "path" : "Patient.extension",
        "sliceName" : "isAccountHolder",
        "min" : 0,
        "max" : "1",
        "type" : [
          {
            "code" : "Extension",
            "profile" : [
              "https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/acholder"
            ]
          }
        ],
        "mustSupport" : true
      },
      {
        "id" : "Patient.extension:accountGroup",
        "path" : "Patient.extension",
        "sliceName" : "accountGroup",
        "min" : 0,
        "max" : "1",
        "type" : [
          {
            "code" : "Extension",
            "profile" : [
              "https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/patient-account-group"
            ]
          }
        ],
        "mustSupport" : true
      },
      {
        "id" : "Patient.extension:accountHeldBy",
        "path" : "Patient.extension",
        "sliceName" : "accountHeldBy",
        "min" : 0,
        "max" : "1",
        "type" : [
          {
            "code" : "Extension",
            "profile" : [
              "https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/acheldby"
            ]
          }
        ],
        "mustSupport" : true
      },
      {
        "id" : "Patient.extension:countryOfBirth",
        "path" : "Patient.extension",
        "sliceName" : "countryOfBirth",
        "min" : 0,
        "max" : "1",
        "type" : [
          {
            "code" : "Extension",
            "profile" : [
              "https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/country-of-birth"
            ]
          }
        ],
        "mustSupport" : true
      },
      {
        "id" : "Patient.identifier",
        "path" : "Patient.identifier",
        "slicing" : {
          "discriminator" : [
            {
              "type" : "pattern",
              "path" : "type"
            }
          ],
          "rules" : "open"
        },
        "type" : [
          {
            "code" : "Identifier",
            "profile" : [
              "http://hl7.org.au/fhir/StructureDefinition/au-ihi",
              "http://hl7.org.au/fhir/StructureDefinition/au-medicarecardnumber",
              "http://hl7.org.au/fhir/StructureDefinition/au-dvanumber",
              "http://hl7.org.au/fhir/StructureDefinition/au-healthcarecardnumber",
              "http://hl7.org.au/fhir/StructureDefinition/au-pensionerconcessioncardnumber",
              "http://hl7.org.au/fhir/StructureDefinition/au-cwlthseniorshealthcardnumber",
              "http://hl7.org.au/fhir/StructureDefinition/au-medicalrecordnumber"
            ]
          }
        ],
        "condition" : ["au-core-pat-01"],
        "mustSupport" : true
      },
      {
        "id" : "Patient.identifier:ihi",
        "path" : "Patient.identifier",
        "sliceName" : "ihi",
        "min" : 0,
        "max" : "*",
        "type" : [
          {
            "code" : "Identifier",
            "profile" : ["http://hl7.org.au/fhir/StructureDefinition/au-ihi"]
          }
        ],
        "mustSupport" : true
      },
      {
        "id" : "Patient.identifier:medicare",
        "path" : "Patient.identifier",
        "sliceName" : "medicare",
        "min" : 0,
        "max" : "*",
        "type" : [
          {
            "code" : "Identifier",
            "profile" : [
              "http://hl7.org.au/fhir/StructureDefinition/au-medicarecardnumber"
            ]
          }
        ],
        "mustSupport" : true
      },
      {
        "id" : "Patient.identifier:dva",
        "path" : "Patient.identifier",
        "sliceName" : "dva",
        "min" : 0,
        "max" : "*",
        "type" : [
          {
            "code" : "Identifier",
            "profile" : ["http://hl7.org.au/fhir/StructureDefinition/au-dvanumber"]
          }
        ],
        "mustSupport" : true
      },
      {
        "id" : "Patient.identifier:dva.type",
        "path" : "Patient.identifier.type",
        "binding" : {
          "strength" : "required",
          "valueSet" : "https://alexapi.medtechglobal.com.au/fhir/ValueSet/patient-dva-entitlement"
        }
      },
      {
        "id" : "Patient.identifier:healthcare",
        "path" : "Patient.identifier",
        "sliceName" : "healthcare",
        "min" : 0,
        "max" : "1",
        "type" : [
          {
            "code" : "Identifier",
            "profile" : [
              "http://hl7.org.au/fhir/StructureDefinition/au-healthcarecardnumber"
            ]
          }
        ],
        "mustSupport" : true
      },
      {
        "id" : "Patient.identifier:pen",
        "path" : "Patient.identifier",
        "sliceName" : "pen",
        "min" : 0,
        "max" : "1",
        "type" : [
          {
            "code" : "Identifier",
            "profile" : [
              "http://hl7.org.au/fhir/StructureDefinition/au-pensionerconcessioncardnumber"
            ]
          }
        ],
        "mustSupport" : true
      },
      {
        "id" : "Patient.identifier:sen",
        "path" : "Patient.identifier",
        "sliceName" : "sen",
        "min" : 0,
        "max" : "1",
        "type" : [
          {
            "code" : "Identifier",
            "profile" : [
              "http://hl7.org.au/fhir/StructureDefinition/au-cwlthseniorshealthcardnumber"
            ]
          }
        ],
        "mustSupport" : true
      },
      {
        "id" : "Patient.identifier:mrn",
        "path" : "Patient.identifier",
        "sliceName" : "mrn",
        "min" : 0,
        "max" : "*",
        "type" : [
          {
            "code" : "Identifier",
            "profile" : [
              "http://hl7.org.au/fhir/StructureDefinition/au-medicalrecordnumber"
            ]
          }
        ],
        "mustSupport" : true
      },
      {
        "id" : "Patient.name",
        "path" : "Patient.name",
        "slicing" : {
          "discriminator" : [
            {
              "type" : "value",
              "path" : "use"
            }
          ],
          "ordered" : false,
          "rules" : "open"
        },
        "min" : 1,
        "max" : "2"
      },
      {
        "id" : "Patient.name:official",
        "path" : "Patient.name",
        "sliceName" : "official",
        "min" : 1,
        "max" : "1",
        "mustSupport" : true
      },
      {
        "id" : "Patient.name:official.use",
        "path" : "Patient.name.use",
        "min" : 1,
        "patternCode" : "official"
      },
      {
        "id" : "Patient.name:official.family",
        "path" : "Patient.name.family",
        "min" : 1,
        "mustSupport" : true
      },
      {
        "id" : "Patient.name:official.given",
        "path" : "Patient.name.given",
        "min" : 1,
        "mustSupport" : true
      },
      {
        "id" : "Patient.name:official.prefix",
        "path" : "Patient.name.prefix",
        "max" : "1",
        "mustSupport" : true
      },
      {
        "id" : "Patient.name:preferred",
        "path" : "Patient.name",
        "sliceName" : "preferred",
        "min" : 0,
        "max" : "1",
        "mustSupport" : true
      },
      {
        "id" : "Patient.name:preferred.use",
        "path" : "Patient.name.use",
        "min" : 1,
        "patternCode" : "usual"
      },
      {
        "id" : "Patient.name:preferred.family",
        "path" : "Patient.name.family",
        "max" : "0",
        "mustSupport" : true
      },
      {
        "id" : "Patient.name:preferred.given",
        "path" : "Patient.name.given",
        "min" : 1,
        "max" : "1",
        "mustSupport" : true
      },
      {
        "id" : "Patient.name:preferred.prefix",
        "path" : "Patient.name.prefix",
        "max" : "1",
        "mustSupport" : true
      },
      {
        "id" : "Patient.telecom",
        "path" : "Patient.telecom",
        "mustSupport" : true
      },
      {
        "id" : "Patient.birthDate",
        "path" : "Patient.birthDate",
        "min" : 1,
        "mustSupport" : true
      },
      {
        "id" : "Patient.birthDate.extension:accuracyIndicator",
        "path" : "Patient.birthDate.extension",
        "sliceName" : "accuracyIndicator",
        "max" : "0"
      },
      {
        "id" : "Patient.birthDate.extension:birthTime",
        "path" : "Patient.birthDate.extension",
        "sliceName" : "birthTime",
        "max" : "0"
      },
      {
        "id" : "Patient.deceased[x]",
        "path" : "Patient.deceased[x]",
        "max" : "0"
      },
      {
        "id" : "Patient.deceased[x]:deceasedBoolean",
        "path" : "Patient.deceased[x]",
        "sliceName" : "deceasedBoolean",
        "max" : "0",
        "type" : [
          {
            "code" : "boolean"
          }
        ]
      },
      {
        "id" : "Patient.deceased[x]:deceasedDateTime",
        "path" : "Patient.deceased[x]",
        "sliceName" : "deceasedDateTime",
        "max" : "0",
        "type" : [
          {
            "code" : "dateTime"
          }
        ]
      },
      {
        "id" : "Patient.address",
        "path" : "Patient.address",
        "max" : "2",
        "type" : [
          {
            "code" : "Address",
            "profile" : [
              "https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/alex-address"
            ]
          }
        ],
        "mustSupport" : true
      },
      {
        "id" : "Patient.address.type",
        "path" : "Patient.address.type",
        "short" : "postal | physical",
        "min" : 1,
        "mustSupport" : true
      },
      {
        "id" : "Patient.maritalStatus",
        "path" : "Patient.maritalStatus",
        "short" : "Patient marital status (Medtech – required)",
        "comment" : "User-defined codes managed in the PMS; canonical system only; code list not published in this IG.",
        "mustSupport" : true,
        "binding" : {
          "strength" : "extensible",
          "valueSet" : "https://alexapi.medtechglobal.com.au/fhir/ValueSet/marital-status"
        }
      },
      {
        "id" : "Patient.maritalStatus.coding.system",
        "path" : "Patient.maritalStatus.coding.system",
        "patternUri" : "https://alexapi.medtechglobal.com.au/fhir/CodeSystem/marital-status"
      },
      {
        "id" : "Patient.multipleBirth[x]",
        "path" : "Patient.multipleBirth[x]",
        "max" : "0"
      },
      {
        "id" : "Patient.photo",
        "path" : "Patient.photo",
        "max" : "0"
      },
      {
        "id" : "Patient.contact",
        "path" : "Patient.contact",
        "slicing" : {
          "discriminator" : [
            {
              "type" : "value",
              "path" : "relationship"
            }
          ],
          "ordered" : false,
          "rules" : "open"
        },
        "mustSupport" : true
      },
      {
        "id" : "Patient.contact.extension",
        "path" : "Patient.contact.extension",
        "slicing" : {
          "discriminator" : [
            {
              "type" : "value",
              "path" : "url"
            }
          ],
          "ordered" : false,
          "rules" : "open"
        }
      },
      {
        "id" : "Patient.contact.extension:contactDefaultFlag",
        "path" : "Patient.contact.extension",
        "sliceName" : "contactDefaultFlag",
        "min" : 0,
        "max" : "1",
        "type" : [
          {
            "code" : "Extension",
            "profile" : [
              "https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/contact-default-flag"
            ]
          }
        ],
        "mustSupport" : true
      },
      {
        "id" : "Patient.contact.extension:contactEmergencyFlag",
        "path" : "Patient.contact.extension",
        "sliceName" : "contactEmergencyFlag",
        "min" : 0,
        "max" : "1",
        "type" : [
          {
            "code" : "Extension",
            "profile" : [
              "https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/contact-emergency-flag"
            ]
          }
        ],
        "mustSupport" : true
      },
      {
        "id" : "Patient.contact.relationship",
        "path" : "Patient.contact.relationship",
        "binding" : {
          "strength" : "required",
          "valueSet" : "https://alexapi.medtechglobal.com.au/fhir/ValueSet/contact-relationship-type-vs"
        }
      },
      {
        "id" : "Patient.contact:nok",
        "path" : "Patient.contact",
        "sliceName" : "nok",
        "min" : 0,
        "max" : "*",
        "mustSupport" : true
      },
      {
        "id" : "Patient.contact:nok.relationship",
        "path" : "Patient.contact.relationship",
        "min" : 1,
        "patternCodeableConcept" : {
          "coding" : [
            {
              "code" : "N"
            }
          ]
        }
      },
      {
        "id" : "Patient.contact:nok.name.text",
        "path" : "Patient.contact.name.text",
        "min" : 1,
        "mustSupport" : true
      },
      {
        "id" : "Patient.contact:nok.telecom",
        "path" : "Patient.contact.telecom",
        "min" : 1,
        "mustSupport" : true
      },
      {
        "id" : "Patient.contact:employer",
        "path" : "Patient.contact",
        "sliceName" : "employer",
        "min" : 0,
        "max" : "*",
        "mustSupport" : true
      },
      {
        "id" : "Patient.contact:employer.relationship",
        "path" : "Patient.contact.relationship",
        "min" : 1,
        "patternCodeableConcept" : {
          "coding" : [
            {
              "code" : "E"
            }
          ]
        }
      },
      {
        "id" : "Patient.generalPractitioner",
        "path" : "Patient.generalPractitioner",
        "max" : "1",
        "mustSupport" : true
      },
      {
        "id" : "Patient.link",
        "path" : "Patient.link",
        "max" : "0"
      }
    ]
  }
}

```
